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

Bertha 。 2022-10-16 07:52 380阅读 0赞

###### 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 登录账号 admin@admin.com 密码 ymfe.org ####

#### idea集成yapi ####

idea插件中搜索YapiUpload下载插件YapiUpload  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNTQ4NzQx_size_16_color_FFFFFF_t_70]  
下载后打开项目中.idea下配置文件misc.xml添加如下配置  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNTQ4NzQx_size_16_color_FFFFFF_t_70 1]

projectToken和projectId对应如下  
![projectToken][]  
yapiUrl为yapi地址  
在任意controller中右键点击UploadToYapi生成文档  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNTQ4NzQx_size_16_color_FFFFFF_t_70 2]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNTQ4NzQx_size_16_color_FFFFFF_t_70 3]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNTQ4NzQx_size_16_color_FFFFFF_t_70]: /images/20221014/8589f01def2b4c5f92944e17a95f94cd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNTQ4NzQx_size_16_color_FFFFFF_t_70 1]: /images/20221014/ffe985b141144063a4271fd3b6f0d958.png
[projectToken]: /images/20221014/cc81e20c8da34e14a92c297c31a8dba5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNTQ4NzQx_size_16_color_FFFFFF_t_70 2]: /images/20221014/43f8e58ca22648249d7e8f841a9ef01f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNTQ4NzQx_size_16_color_FFFFFF_t_70 3]: /images/20221014/04700af94046470e84833cfea02ae733.png