docker笔记 yapi安装并使用idea集成yapi快速生成接口文档

docker安装并运行mongo

#下载镜像
docker pull mongo
#启动
docker run -d --name mongo-yapi mongo

获取 Yapi 镜像

docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi

初始化 Yapi 数据库索引及管理员账号

docker run -it --rm \
  --link mongo-yapi:mongo \
  --entrypoint npm \
  --workdir /api/vendors \
  registry.cn-hangzhou.aliyuncs.com/anoy/yapi \
  run install-server

启动 Yapi 服务

docker run -d \
  --name yapi \
  --link mongo-yapi:mongo \
  --workdir /api/vendors \
  -p 3000:3000 \
  registry.cn-hangzhou.aliyuncs.com/anoy/yapi \
  server/app.js

访问 http://ip:3000 登录账号 [email protected] 密码 ymfe.org

idea集成yapi

idea插件中搜索YapiUpload下载插件YapiUpload

下载后打开项目中.idea下配置文件misc.xml添加如下配置

>
    >322a37a32527c6ad68fc269d347cb970cb581faad024a326fa4a16aaf3ca4b3b>
    >13>
    >http://192.168.164.128:3000>
    >api>
  >

projectToken和projectId对应如下

yapiUrl为yapi地址
在任意controller中右键点击UploadToYapi生成文档