利用docker-compose搭建yapi

yapi介绍

随着时间的推移，一个公司的项目或系统会比较多，对内对外提供的 api 接口也比较多，为了能够对 api 接口文档进行统一维护，方便不同的人员（项目经理、产品经理，开发人员）进行查阅，很有必要搭建一个 api 接口文档管理系统。

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

本篇博客将介绍如何利用docker-compose快速进行搭建 Yapi 

Yapi 的源代码地址：https://github.com/YMFE/yapi
Yapi 的帮助文档地址：https://hellosean1025.github.io/yapi
EasyYapi 插件的官网地址：https://easyyapi.com/index.html

搭建Yapi系统

本人环境	CentOS 7.6 64bit
将在三无环境下直接安装并使用Yapi系统
Yapi 使用 mongodb 作为数据库，由于 Yapi 一般在公司内部使用，搭建单机版 mongodb 即可满足需求

1 安装docker

sudo yum install -y yum-utils device-mapper-persistent-data lvm2
sudo yum-config-manager --add-repo http://mirrors.aliyun.com/docker-ce/linux/centos/docker-ce.repo
sudo yum install docker-ce
systemctl start docker

2 安装docker-compose

1、可以从官方 Docker Compose GitHub 仓库获取最新的发布版本：
curl -L https://github.com/docker/compose/releases/download/1.29.2/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
请将 1.29.2 替换为你希望安装的 Docker Compose 的版本号。

2、设置执行权限：
确保下载的 docker-compose 文件有执行权限：
sudo chmod +x /usr/local/bin/docker-compose

3、验证安装：
验证 docker-compose 是否正确安装：
docker-compose --version

3 新建docker-compose.yml

vim docker-compose.yml

version: "3.5"
services:
  mongodb:
    container_name: mongodb
    image: mongo:latest
    restart: always
    ports:
      - 27017:27017
    environment:
      - MONGO_INITDB_ROOT_USERNAME=admin
      - MONGO_INITDB_ROOT_PASSWORD=123456
    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=a@qq.com
   		# 设置账号的密码
      - YAPI_ADMIN_PASSWORD=admin
			# 禁用注册功能  这样的话就只有上面这个用户可以登陆，如果有其他用户需求，将此注释或者直接去掉即可
      # - YAPI_CLOSE_REGISTER=true
      # 设置连接 mongdb 的服务器地址，可以使用容器内部的 mongodb 服务名称
      - YAPI_DB_SERVERNAME=mongodb
      # mongoDB的连接信息
      - YAPI_DB_PORT=27017
      - YAPI_DB_DATABASE=yapidb
      - YAPI_DB_USER=admin
      - YAPI_DB_PASS=123456
      - YAPI_DB_AUTH_SOURCE=admin
      #- YAPI_DB_CONNECT_STRING="mongodb://admin:123456@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 数据库、以及相关表和数据。
上述参数代码如果需要直接复制到linux环境中最好将注释先行去掉之后在复制到配置文件中即可

4 启动

docker-compose up -d # 启动
docker-compose stop  # 停止
docker-compose rm    # 删除

5 访问

http://127.0.0.1:3000/        或者本地ip:3000即可
输入邮箱：为上述注释的邮箱账号
输入密码：admin