idea集成YapiUpload插件,生成文档
- 在idea -> File下Settings里,找到Plugins,搜索YapiUpload,安装
2.在项目中的.idea文件中,找到misc.xml文件
3.在misc.xml文件中添加如下配置(下面的配置数据,仅供参考!projectToken,yapiUrl需按照自己的Yapi账号上配置填写)
<!--yapi配置-->
<component name="yapi">
<option name="projectToken">666587a633416fde42ef69dea9236a39021b74e4f6ed55bfbbd506b50bf707a5</option>
<option name="projectId">119</option>
<option name="yapiUrl">http://192.168.1.158:3000</option>
<option name="projectType">api</option>
</component>
上面projectToken来源,(先要注册yapi账号,登录后可查询到,一般公司会提供)
4.将要提交到Yapi的接口,添加参数说明,选中接口 “右击”选择UploadToYapi,即可上传到Yapi服务器上
5.登录Yapi账号,右上角 “搜索分组/项目/接口”,这里通过接口上的注释进行搜索
6.找到对应接口后,点击“编辑”,(这里以导入JSON方法为例)选择“导入Json”,可以通过postman或第三方测试工具,将测试的json结果粘贴到此,点击确定即可自动解析字段,这时你只要在每个字段后添加对应的备注即可,最后别忘记保存!
版权声明:本文为demonSily原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明。




