简述idea使用YApi生成接口文档

作者：2023面试高手 | 2024-05-12 17:58:20

踩

yapi生成接口文档

1.准备YApi路径，然后有自己的账号密码，创建项目组，然后粘贴出来token
在这里插入图片描述
2.还有项目ID

3.在idea安装YapiUpload插件

4.在idea自己的项目中找到“misc.xml”添加以下的节点

在这里插入图片描述

<component name="yapi">
    <option name="projectToken">Yapi的项目token</option>
    <option name="projectId">Yapi的项目ID</option>
    <option name="yapiUrl">Yapi的地址及端口</option>
    <option name="projectType">api</option>
  </component>
1
2
3
4
5
6

5.然后右击控制层类或者接口方法，点击图中的选项操作即可，这样接口文档就生成到YApi你创建的那个项目中了。
注意：在代码中接口注释一定要写好，否则生成出来的接口文档就没啥意义了。
在这里插入图片描述

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/2023面试高手/article/detail/560081