idea中使用yapi插件自动生成yapi接口文档

1、在idea的plugin中搜索easy-yapi插件

2、安装后重启idea

3、打开setting，在Other Settings下出现EasyApi菜单项，点开出现如下界面

4、填充Yapi地址

5、打开我们想要生成Yapi文档的Controller中

6、同时按住 Shift + Alt + E 即会出现如下弹窗

7、点击绿色钩子后，会弹出一个输入框，让你输入Yapi对应项目下的Token

8、打开Yapi中对应的项目，在设置下的token配置中，找到对应的token，点击右边的复制

9、将复制的token贴入idea中的弹框中

10、点击OK，后即可在Yapi的接口列表中出现对应的接口文档

11、如果代码请求体或返回体发生了变更，这里测试新增一个userName的入参

12、再次上传到Yapi，Yapi该接口的文档会被更新

补充一下图中的返回体结构

ResBean.class

package com.lbb.model.dto;import com.fasterxml.jackson.annotation.JsonInclude;
import com.lbb.model.enums.BizErrorEnum;
import lombok.Data;@Data
@JsonInclude(JsonInclude.Include.NON_NULL)
public class ResBean<T> {private static final String SUCCESS_CODE = "200";/*** 返回code码，200成功，其他失败*/private String code;/*** 错误信息*/private String errorMsg;/*** 返回体*/private T data;/*** 成功返回** @return*/public static <T> ResBean<T> success() {return new ResBean<>();}/*** 成功返回携带数据体** @param data* @return*/public static <T> ResBean<T> successWithObj(T data) {ResBean<T> resBean = new ResBean<>();resBean.setCode(SUCCESS_CODE);resBean.setData(data);return resBean;}/*** 错误返回携带信息** @param errorCode* @param errorMsg* @return*/public static <T> ResBean<T> failWithMsg(String errorCode, String errorMsg) {ResBean<T> resBean = new ResBean<>();resBean.setCode(errorCode);resBean.setErrorMsg(errorMsg);return resBean;}/*** 错误返回携带数据体** @param errorCode* @param data* @return*/public static <T> ResBean<T> failWithObj(String errorCode, T data) {ResBean<T> resBean = new ResBean<>();resBean.setCode(errorCode);resBean.setData(data);return resBean;}public static <T> ResBean<T> failWithErrorEnum(BizErrorEnum errorEnum) {return failWithMsg(errorEnum.getCode(), errorEnum.getMsg());}
}

UserVO.class

package com.lbb.model.vo;import lombok.Data;import java.util.List;/*** 用户对象*/
@Data
public class UserVO {/*** 用户id*/private Integer userId;/*** 用户名*/private String userName;/*** 年龄*/private Integer age;/*** 兴趣爱好*/private List<String> habbits;}

idea中使用yapi插件自动生成yapi接口文档相关推荐

python生成api文档_Django 自动生成api接口文档教程
最近在写测试平台,需要实现一个节点服务器的api,正好在用django,准备使用djangorestframework插件实现. 需求实现一个接口,在调用时,通过传递的参数,直接运行对应项目的自动化 ...
python api接口生成_Django 自动生成api接口文档教程
最近在写测试平台,需要实现一个节点服务器的api,正好在用django,准备使用djangorestframework插件实现. 需求实现一个接口,在调用时,通过传递的参数,直接运行对应项目的自动化 ...
自动生成python接口文档_Django自动生成Swagger接口文档
Django自动生成Swagger接口文档 1. 前言当接口开发完成,紧接着需要编写接口文档.传统的接口文档通常都是使用Word或者一些接口文档管理平台进行编写,但此类接口文档维护更新比较麻烦,每次 ...
如何自动生成 API 接口文档 - 一份详细指南
本篇文章详细教你如何使用 Apifox 的 IDEA 插件实现自动生成接口代码.好处简单总结有以下几点: 自动生成接口文档: 不用手写,一键点击就可以自动生成文档,当有更新时,点击一下就可以自动同步接 ...
Laravel使用Apidoc注解自动生成Api接口文档
本教程从零开始搭建laravel项目,并安装Apidoc扩展及使用注解生成Api接口文档的教程,该扩展支持多应用/版本.Markdown文档.在线接口调试.接口生成器.代码模板生成器.Mock调试数 ...
coreapi自动生成API接口文档
文章目录 1 安装: 2 在路由中配置视图中使用方法 1 安装: pip install coreapi 2 在路由中配置 from rest_framework.documentation imp ...
Spring MVC学习总结（9）——Spring MVC整合swagger自动生成api接口文档
Swagger 号称:世界最流行的API框架,官网:http://swagger.io/,Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总 ...
apidoc 自动化生成 api接口文档
手写api接口太麻烦. 学习了apidoc自动生成接口文档,这边做一下整理要用组件那就必须先安装 apidoc,做一下全局安装 npm install apidoc -g 新建配置文件apidoc. ...
FastAPI 自动生成的docs文档没法使用
FastAPI 自动生成的docs文档没法使用,当展开路径时候一直在转圈,具体就是这样这个是由于swagger-ui 3.30.1 中的bug导致,具体bug可以看这里我们可以通过在FastAPI ...

idea中使用yapi插件自动生成yapi接口文档

1、在idea的plugin中搜索easy-yapi插件

2、安装后重启idea

3、打开setting，在Other Settings下出现EasyApi菜单项，点开出现如下界面

4、填充Yapi地址

5、打开我们想要生成Yapi文档的Controller中

6、同时按住 Shift + Alt + E 即会出现如下弹窗

7、点击绿色钩子后，会弹出一个输入框，让你输入Yapi对应项目下的Token

8、打开Yapi中对应的项目，在设置下的token配置中，找到对应的token，点击右边的复制

9、将复制的token贴入idea中的弹框中

10、点击OK，后即可在Yapi的接口列表中出现对应的接口文档

11、如果代码请求体或返回体发生了变更，这里测试新增一个userName的入参

12、再次上传到Yapi，Yapi该接口的文档会被更新

补充一下图中的返回体结构

idea中使用yapi插件自动生成yapi接口文档相关推荐

最新文章

热门文章