yapi文档使用说明记录

1. yapi文档地址：http://192.168.0.97:3000/

   

 

 

2. 在idea下载插件：easy-yapi

 

 

3. 配置插件

 

在 Settings->Other Settings -> EasyAPI 中的 **server **栏中填写服务器地址：http://yapi.gwm.cn/

在 Settings->Other Settings -> EasyAPI 的 **tokens **中填写项目 token。一个项目对应一个 token。这步可以跳过。没有填写时后面上传会提醒填写。

 

 

 

 

 

 

Token在yapi对应的项目里面：以community为例：

 

 

 

 

4. 上传接口使用

 

接口写完后，在 Controller 类中单击右键：点击 **ExportToYapi 或者 Export **都可以上传接口。

推荐使用 Export 方式上传。Export 可以选择上传哪些接口。ExportToYapi 会把类里的接口都上传，如果 Yapi 中有过编辑更改的话，会被覆盖调。

 

 

 

 

 

导出成功截图

 

 

 

6. 注意事项

给接口添加注释

Yapi 是通过扫描类来获取接口的信息生成文档，所以如果添加一定的注释会更有利于文档的生成，减少后续的编辑操作。
下面两个接口一个有注释，一个没有，生成的文档会不一样。

  

 

 

 

 

 

2.参数的备注

一般如果是单个参数，直接在类上面自定义注释即可。

 

 

 

 

如果的dto类型的入参和返回参数，使用

/**

 * 备注

* @mock,可选，如果有其他信息

*/

 

 

 

 

 

3.使用泛型

项目中的 Result 是支持泛型的，编写接口时把泛型指定上，这样 Yapi 才能识别出返回数据的类型去扫描获取信息。

·        public class Result<T>

 

 

 

 

 

 

如上，如果不指定类型，返回数据会是data.解决方式就是Result<T>泛型里面加上具体的类型。

3.如果需要全量导入，直接在对应的controller进行全量导入：

·        

 

 

参考：https://blog.csdn.net/weixin_42183401/article/details/127497342