YAPI 使用文档

简介

为 API 开发者设计的管理平台。
YApi 让接口开发更简单高效，让接口的管理更具可读性、可维护性，让团队协作更合理。

• 项目管理
  • 提供基本的项目分组，项目管理，接口管理功能
• 接口管理
  • 友好的接口文档，基于 websocket 的多人协作接口编辑功能和类 postman 测试工具
• MockServer
  • 基于 Mockjs，使用简单功能强大

使用

暂时在我的电脑上搭了一个 demo。访问地址：http://192.168.0.97:3000/

注册账号

注册账号后将用户名告诉超级管理员（me-asia），管理员邀请加入项目。

查看项目

加入项目成功后，就可在页面上看到分组和组内的项目。

点击 Web 项目即可看到上传至 YApi 的接口列表

点击一个接口查看详细信息

编辑可以对接口信息添加描述备注等相关信息。

导出 JSON

在项目的** 数据管理 **菜单下可以导出导入接口信息。

项目 token

每个项目都有一个唯一的 token 值，后面在 Idea 中上传接口需要用到。

Idea 上传接口

安装 easy-yapi 插件

设置服务器和 token

插件安装完成后设置服务器和 token

• 在 Settings->Other Settings -> EasyAPI 中的 **server **栏中填写服务器地址：http://192.168.0.97:3000/ （demo）
• 在 Settings->Other Settings -> EasyAPI 的 **tokens **中填写上面提到过的项目 token。一个项目对应一个 token。这步可以跳过。没有填写时后面上传会提醒填写。

上传接口

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

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

2. 如果前面没有设置 token，此时会弹框提示填写项目的 token。填写后即可上传。

3. Export 选择接口上传

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

点击需要的接口（变蓝色底），按 Enter 或点击绿色的√上传。

上传成功会有 success info 提示。

注意事项

给接口添加注释

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

可以看到，有注释生成的文档信息更加丰富 ，便于理解。

使用泛型

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

public class CommonResult implements Serializable {

不指定泛型结果如上所述：只会把 data 当成一个 object 处理，得不到任何有用的信息！！！！！
**指定泛型后 **yapi 可以找到类扫描得到更多的信息。结果如下。

所以使用 CommonResult 的时候记得指定泛型。
一般没有指定泛型 idea 也会提示