docker搭建Yapi实现接口文档管理

一. Yapi

1.1 简介

Yapi,一个高效,易用,功能强大的API管理平台,旨在为开发,测试,产品人员提供更优雅的接口管理服务.

1.2 安装

1.2.1 编写docker-compose.yml

version: '3'
services:
  yapi:
    image: jayfong/yapi
    container_name: yapi
    ports:
      - 3001:3000
    environment:
      - YAPI_ADMIN_ACCOUNT=管理员账号
      - YAPI_ADMIN_PASSWORD=管理员密码
      - YAPI_DB_SERVERNAME=yapi-mongo
      - YAPI_DB_PORT=27017
      - YAPI_DB_DATABASE=yapi
      - YAPI_DB_AUTH_SOURCE=admin
    volumes:
      - ./logs:/yapi/log
    networks:
      - yapi-net
    depends_on:
      - yapi-mongo

  yapi-mongo:
    image: mongo
    container_name: yapi-mongo
    ports:
      - 27017:27017
    volumes:
      - ./mongodb:/data/db
    networks:
      - yapi-net

networks:
  yapi-net:
    external: true

1.2.2 启动

# 创建自定义网络
[root@freedev yapi]# docker network create yapi-net
# 启动
[root@freedev yapi]# docker-compose up -d
# 查看启动日志
[root@freedev yapi]# docker logs -f -t containerId

1.2.3 访问页面

输入docker-compose.yml文件中定义的用户名密码登录即可;

1.2.4 使用Yapi创建项目

填写天目名称,分组,请求路径即可完成创建,接下来就可以愉快的编写接口文档了,也可以使用下面的插件工具自动生成;

二. IDEA集成EasyYapi插件

2.1 插件安装

在IDEA的plugins中搜索安装EasyYapi,然后重启;

2.2 配置Yapi

填写Yapi地址及项目的token,token可以配置多个;

Token可以在项目==>设置==>token配置中找到:

2.3 将接口导入到Yapi

1. 在需要导入接口的类上点击右键==>Generate按钮;

2. 导入有两种方式;
   

    a). Export Yapi: 会导入当前类所有方法到Yapi(会覆盖之前的接口文档);
    b). Export api: 选择导入某些方法;
   

3. 这里我们选择第二种方式,选择需要导入到Yapi的接口回车即可;
   
   

Yapi配置到此结束,接下来我们就可以愉快的写BUG了

参考资料:

• Yapi官网
• Github
• Gitee