使用 docker-compose 部署和使用 Yapi

Yapi 就是一款高效、易用、功能强大的 api 管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 api，YApi 还为用户提供了优秀的交互体验，开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。

本篇博客将介绍如何快速进行搭建 Yapi ，在 IDEA 开发工具安装 EasyYapi 插件，向 Yapi 系统发布接口文档。

Yapi 的源代码地址：GitHub - YMFE/yapi: YApi 是一个可本地部署的、打通前后端及QA的、可视化的接口管理平台

Yapi 的帮助文档地址：YApi 接口管理平台

EasyYapi 插件的官网地址：easyyapi

前提是安装好了 docker 和 docker-compose。如果没有的话先提前安装

# 验证Docker

docker --version

# 验证Docker Compose

docker-compose --version

Yapi 使用 mongodb 作为数据库，由于 Yapi 一般在公司内部使用，搭建单机版 mongodb 即可满足需求

首先在 CentOS7 中创建目录 /app/yapi，里面创建子目录 mongodb_data 和 docker-compose.yml 文件

编写 docker-compose.yml 文件内容如下：

version: "3.5"
services:
  mongodb:
    container_name: mongodb
    image: mongo:latest
    restart: always
    ports:
      - 27017:27017
    environment:
      - MONGO_INITDB_ROOT_USERNAME=yapi
      - MONGO_INITDB_ROOT_PASSWORD=yapi
    volumes:
      - /app/yapi/mongodb_data:/data/db
    networks:
      - yapi_net
    # 增加启动参数，--auth，表示连接 mongodb 需要用户名和密码
    command:
      - "--auth"
 
  yapi:
    image: jayfong/yapi:latest
    container_name: yapi
    restart: always
    ports:
      - 3000:3000
    environment:
      # 随便设置一个账号（账号是邮箱的格式）
      - YAPI_ADMIN_ACCOUNT=admin@admin.com
      # 设置账号的密码
      - YAPI_ADMIN_PASSWORD=123456
      # 禁用注册功能
      - YAPI_CLOSE_REGISTER=true
      # 设置连接 mongdb 的服务器地址，可以使用容器内部的 mongodb 服务名称
      - YAPI_DB_SERVERNAME=mongodb
      - YAPI_DB_PORT=27017
      - YAPI_DB_DATABASE=yapidb
      - YAPI_DB_USER=yapi
      - YAPI_DB_PASS=yapi
      - YAPI_DB_AUTH_SOURCE=admin
      #- YAPI_DB_CONNECT_STRING="mongodb://yapi:yapi@mongodb:27017/yapidb?authSource=admin"
      # 禁用发送邮件的功能
      - YAPI_MAIL_ENABLE=false
      # 禁用 LDAP 登录功能
      - YAPI_LDAP_LOGIN_ENABLE=false
      # 不使用任何插件
      - YAPI_PLUGINS=[]
    networks:
      - yapi_net
    depends_on:
      - mongodb
 
networks:
  yapi_net:
    driver: bridge

不需要在 mongodb 中提前创建数据库，启动服务后会自动创建并初始化所配置的 mongodb 数据库、以及相关表和数据。

最后在该目录下运行 docker-compose up -d 命令启动服务，访问 http://ip:3000 即可

登录账号密码就是： 这里自己写的多少就是多少

- YAPI_ADMIN_ACCOUNT=admin@admin.com
- YAPI_ADMIN_PASSWORD=123456