使用yapi、idea提供api文档整体操作流程

前言: Swagger-ui代码侵入型太强固使用yapi来做api文档提供工具.

1. 搭建yapi
2. 在idea中下载yapi的插件
   
3. 下载yapi插件后在msic.xml文件中加入如下配置

  <component name="yapi">
    <option name="projectToken">${token}</option>
    <option name="projectId">${id}</option>
    <option name="yapiUrl">http://127.0.0.1:3000/</option>
    <option name="projectType">api</option>
  </component>

其中token和id从yapi设置中获取.yapiUrl给上对应的地址、projectType给定api即可

4. 上传yapi在controller中右键upload即可

上传后在yapi的接口中即可查看

yapi读取javaDoc作为注释,非常低的代码侵入型写好规范的javadoc即可.

yapi文档戳我

希望对你有帮助~