docker-compose 之 yapi 在线接口文档

yapi 可视化在线接口文档

一、安装mongo

自行安装，或者使用你现有的，此处（略），可以参考 docker 安装 mongodb
PS：本人不喜欢把mongo耦合到这个docker中，重装docker什么的还得备份，所以最好还是单独安装一个 mongodb。

在 mongodb 中创建用户 yapi，密码 yapi，数据库 yapi（根据自己情况起名）

二、docker-compose.yml

  mongo-db:
    image: mongo:latest
    container_name: mongo-db
    #network_mode: "host"
    restart: always
    ports:
      - 27017:27017
    environment:
      TZ: Asia/Shanghai
      MONGO_INITDB_ROOT_USERNAME: admin
      MONGO_INITDB_ROOT_PASSWORD: admin@123
    volumes:
      - /opt/shanhy/mongo/db:/data/db
      - /etc/localtime:/etc/localtime
    logging:
      driver: "json-file"
      options:
        max-size: "200k"
        max-file: "10"

  mongo-express:
    image: mongo-express:latest
    container_name: mongo-express
    restart: always
    links:
      - mongo-db:mongodb
    depends_on:
      - mongo-db
    ports:
      - 27018:8081
    environment:
      ME_CONFIG_OPTIONS_EDITORTHEME: 3024-night
      ME_CONFIG_MONGODB_SERVER: mongodb
      ME_CONFIG_MONGODB_ADMINUSERNAME: admin
      ME_CONFIG_MONGODB_ADMINPASSWORD: admin@123
      ME_CONFIG_BASICAUTH_USERNAME: admin
      ME_CONFIG_BASICAUTH_PASSWORD: admin@123

  yapi:
    image: xzxiaoshan/yapi
    container_name: yapi
    network_mode: "host"
    environment:
      SERVER_PORT: 3000
    volumes:
      - /opt/shanhy/yapi/config.json:/api/config.json
    depends_on:
      - mongo-db
    logging:
      driver: "json-file"
      options:
        max-size: "200k"
        max-file: "10"

三、创建配置文件

创建配置文件 /opt/shanhy/yapi/config.json 内容为：

{
  "port": "3000",
  "adminAccount": "admin@admin.com",
  "db": {
    "servername": "127.0.0.1",
    "DATABASE": "yapi",
    "port": 27017,
    "user": "admin",
    "pass": "admin@123",
    "authSource": "admin"
  },
  "mail": {
    "enable": true,
    "host": "smtp.163.com",
    "port": 465,
    "from": "***@163.com",
    "auth": {
      "user": "***@163.com",
      "pass": "*****"
    }
  }
}

配置文件中的内容一目了然，请对应修改之。

四、启动容器

启动docker

docker-compose up -d

初始化DB

docker exec -it yapi npm run install-server

五、访问yapi

访问 http://192.168.x.x:3000 登录账号为 config.json 中的 adminAccount admin@admin.com，密码 ymfe.org

---

（END）