idea同步yapi插件

1、前言

yapi是一个很好的接口文档维护工具，其swagger功能，可将接口信息同步到yapi平台上，但是swagger的编写，大量入侵代码，也加大了开发工作量，目前调研了idea集成yapi同步工具，无需嵌入式编写入侵代码，根据javadoc备注即可将接口信息同步到yapi同台上

2、idea同步yapi平台工具

Idea支持将接口文档同步到yapi目前找到三个，easyapi、YapiUpload、idea yapi

  • easyapi：同步接口信息到postman以及yapi平台上，但是同步yapi的不支持多模块同步；
  • YapiUpload：同步yapi的配置需要写配置文件，不利于维护；
  • idea yapi：是基于YapiUpload的二次开发，将原有xml配置方式改为 Setting 中配置，并配置持久化，将原本上传的数据类型做了优化，上传后数据类型为js的数据类型。

综上优缺点，可采用idea yapi，如果有特殊需求可安装easyapi同步到postman进行接口调试

3、idea-yapi安装步骤

3.1、安装idea-yapi

在idea-Preferences-Plugins中搜索idea-yapi，安装，并重启idea
在这里插入图片描述

3.2、配置idea-yapi

在idea-Preferences-Other Setting中找到YapiSetting
配置说明如下：在这里插入图片描述
如果你是项目只是同步dubbo/api，采用如下配置

{
  "isSingle": true,
  "singleConfig": {
    "projectToken": "yapi平台的项目token地址",
    "projectId": "yapi平台的项目id",
    "yApiUrl": "yapi平台平台地址",
    "menu": "同步到的接口的目录",
    "projectType": "你的接口类型或者dubbo"
  },
  "multipleConfig": {
    "api": {
      "projectToken": "",
      "projectId": "",
      "yApiUrl": "",
      "menu": "",
      "projectType": ""
    },
    "api": {
      "projectToken": "",
      "projectId": "",
      "yApiUrl": "",
      "menu": "",
      "projectType": ""
    }
  }
}

如果你是项目即同步dubbo又有api，采用如下配置

{
  "isSingle": false,
  "singleConfig": {
    "projectToken": "",
    "projectId": "",
    "yApiUrl": "",
    "menu": "",
    "projectType": ""
  },
  "multipleConfig": {
    "接口所在包名称: {
       "projectToken": "yapi平台的项目token地址",
       "projectId": "yapi平台的项目id",
       "yApiUrl": "yapi平台平台地址",
       "menu": "api接口文档",
        "projectType": "api"
    },
    "dubbo所在包名称": {
      "projectToken": "yapi平台的项目token地址",
       "projectId": "yapi平台的项目id",
       "yApiUrl": "yapi平台平台地址",
       "menu": "dubbo文档",
        "projectType": "dubbo"
    }
  }
}

备注：查找token以及项目id的目录
在这里插入图片描述

3.3、同步接口或者dubbo

找到对应的接口所在的方法入口或者dubbbo的定义方法，即可
比如：同步下面的接口
在这里插入图片描述
效果如下：
在这里插入图片描述

4、idea-yapi支持规则配置以及实例

4.1、规则配置

1:插件如何生成属性备注 ,通过获得字段备注中的注释

/** 
* 年龄
*/
private Integer age;

2:插件如何生成接口名称，通过接口上的注释，或者引用上的 注释

/**
     * 添加或更新课程数据
     *
     * @param courseOpt
     * @return {@link CommonRes}
     */
    @RequestMapping(value = "/test", method = RequestMethod.POST)
    public Course addOrUpdateCourse(@RequestBody CourseParam courseParam){
    
    }
    
    
    /**
     * @description: 添加或更新课程数据  (@Description 也可）
     * @param: [CourseParam]
     * @return: Course
     * @date: 2018/3/15
     */
     @RequestMapping(value = "/test", method = RequestMethod.POST)
     public Course addOrUpdateCourse(@RequestBody CourseParam courseParam){
    
    }

    
     
     @RequestMapping(value = ICourse.ADD_OR_UPDATA_COURSE, method = RequestMethod.POST)
     public Course addOrUpdateCourse(@RequestBody CourseParam courseParam){
    
     }

     public interface  ICourse{
       /**
        * @description: 添加或更新课程数据  (@Description 也可）
        * @param: [CourseParam]
       */
       ADD_OR_UPDATA_COURSE="test";
     }

3:@link 参数定义展示在字段备注中
第一种@link 方式

/** 
* 状态 {@link com.xxx.constant.StatusConstant}
*/
private Integer status;

第二种@link 方式

import com.xxx.constant.StatusConstant;

/** 
* 状态 {@link StatusConstant}
*/
private Integer status;

不支持方式

import com.xxx.constant.*;

/** 
* 状态 {@link StatusConstant}
*/
private Integer status;

4:实现自定义分类
通过在方法或类注释中加 @menu 注释实现，优先级 方法>类>package 下面或者上面的@menu,如果没有自定义 默认为tool-tmp,支持多级分类（多级分类只能是crazy 分支的yapi)

package com.project.demo;
/** 
 * @menu 这里填写类分类名称
 */
import com......
/** 
 *@description: 用户控制器
 *@menu 这里填写类分类名称
 */   
@RestController
public class UserController {

    /**
     * @description: 新增用户
     * @param: [User]
     * @menu: 这里填写方法级别分类名称（比如 多级目录/menu/menu1/menu2)
     * @return: Response<UserDTO>
     * @date: 2018/3/15
     */
     @RequestMapping(value = "/addUser", method = RequestMethod.POST)
     public Response<UserDTO> addUser(@RequestBody User user){
    
    }
}

5:支持注解

  String RequestMapping="org.springframework.web.bind.annotation.RequestMapping";

    String GetMapping="org.springframework.web.bind.annotation.GetMapping";

    String PostMapping="org.springframework.web.bind.annotation.PostMapping";

    String PutMapping="org.springframework.web.bind.annotation.PutMapping";

    String DeleteMapping="org.springframework.web.bind.annotation.PutMapping.DeleteMapping";

    String PatchMapping="org.springframework.web.bind.annotation.PutMapping.PatchMapping";

    String RequestBody="org.springframework.web.bind.annotation.RequestBody";

    String RequestParam="org.springframework.web.bind.annotation.RequestParam";

    String RequestHeader="org.springframework.web.bind.annotation.RequestHeader";

    String RequestAttribute="org.springframework.web.bind.annotation.RequestAttribute";
   
    String PathVariable="org.springframework.web.bind.annotation.PathVariable";

    String NotNull="javax.validation.constraints.NotNull";
   
    String NotEmpty="javax.validation.constraints.NotEmpty";

    String NotBlank="javax.validation.constraints.NotBlank";

支持Request Param 注解
生成的 uid 和bid 备注为 用户id(Integer),baby id(Integer) 如果没有备注，则只有(Integer)

   /**
     * 测试RequestHeader desc 规范的多个
     * @param uid 用户id
     * @param bid baby id
     * @param request
     * @param response
     */
    @RequestMapping(value = "/testRequestDesc4")
    public void testRequestDesc4(@RequestHeader(name = "uid")Integer uid, @RequestParam(name = "bid")Integer bid, HttpServletRequest request, HttpServletResponse response){

    }

支持@status注解
支持已发布(done),设计中(design),开发中(undone),已提测(testing),已过时(deprecated),暂停开发(stoping),支持中英文 （crazy 分支)，新增接口默认 开发中,更新时如果没有写status情况下默认使用当前状态

   /**
     * 测试RequestHeader desc 规范的多个
     * @param uid 用户id
     * @status 开发中 (或者 undone)
     * @param request
     * @param response
     */
    @RequestMapping(value = "/testRequestDesc4")
    public void testRequestDesc4(@RequestHeader(name = "uid")Integer uid, @RequestParam(name = "bid")Integer bid, HttpServletRequest request, HttpServletResponse response){

    }

6:项目中通过fitler或拦截器或注解等 实现全局统一响应对象 返回如何处理
在misc.xml 中配置 returnClass ，值为全局统一响应对象全路径。比如下面代码如果配置了returnClass 为GlobalResponse ,那么他生成的yapi 响应对象为，GlobalResponse

   /**
     * 测试RequestHeader desc 规范的多个
     * @param uid 用户id
     * @status 开发中 (或者 undone)
     * @param request
     * @param response
     */
    @RequestMapping(value = "/testRequestDesc4")
    public Integer testRequestDesc4(@RequestHeader(name = "uid")Integer uid, @RequestParam(name = "bid")Integer bid, HttpServletRequest request, HttpServletResponse response){

    }


public class GlobalResponse<T> {

    private String status;

    private String code;

    private T data;

  ......
}

7:swagger 支持
目前1.7.7以上支持以下注解

  String API_OPERATION = "io.swagger.annotations.ApiOperation";

  String API_MODEL_PROPERTY = "io.swagger.annotations.ApiModelProperty";

  String API_PARAM = "io.swagger.annotations.ApiParam";

4.2、实例

4.2.1、get方式

        /**
         * get方式
         *
         * @param param1 参数1的名称或描述
         * @param param2 参数2的名称或描述
         * @param param3 参数3的名称或描述
         * @return 响应描述
         * @author 苏叶
         * @date 2019-12-29 17:24
         */
        @RequestMapping(value = "/pathOfApi1", method = RequestMethod.GET)
        public Response<GuideResult> methodName1(@RequestParam String param1,
                                                 @RequestParam String param2,
                                                 @RequestParam(required = false, defaultValue = "android") String param3) {
            return new Response<GuideResult>();
        }

效果
在这里插入图片描述

4.2.2、Post方式

       /**
         * post方式
         *
         * @param jsonModel 入参数
         * @return 通用返回
         * @author 苏叶
         * @date 2019-12-29 17:20
         */
        @Deprecated
        @RequestMapping(value = "/pathOfApi2", method = RequestMethod.POST)
        public Response methodName2(@RequestBody MockDtoOrVo jsonModel) {
            return new Response();
        }

MockDtoOrVo 入参

/**
 * moke说明
 *
 * @author 苏叶
 * @version 1.0
 * @date 2019-12-29 16:58
 */
@Data
@ToString
public class MockDtoOrVo {

    /**
     * 字段注释
     */
    private Long field1;

    /**
     * 字段注释
     */
    private Double field2;

    /**
     * 某个枚举
     * {@link com.kaishustory.userx.common.constant.ClientForm}
     */
    private int field3;

    /**
     * 当目标枚举字段与当前字段名不一致,额外指定
     *
     * @see com.kaishustory.userx.common.constant.ClientForm#ANDROID
     */
    private int field4;

    /**
     * 可以用注解`@Deprecated`来表示字段被废弃
     * 也可以用注释`@deprecated`
     *
     * @deprecated It's a secret
     */
    @Deprecated
    private int field5;

    /**
     * 如果使用javax.validation的话
     * 可以使用@NotBlank/@NotNull表示字段必须
     */
    @NotBlank
    @NotNull
    private String field6;

}

效果
在这里插入图片描述

5、EasyApi安装步骤

5.1、安装EasyApi

在idea-Preferences-Plugins中搜索easyapi，安装，并重启idea
在这里插入图片描述

5.2、创建postmantoken获取token

在这里插入图片描述

5.3、配置easyapi导出postman

在这里插入图片描述

5.4、项目配置

.easy.api.yml
实例在moudle下面配置如下
在这里插入图片描述
在对应的controller文件右键-genernate - export postman，即可在这里插入图片描述生成对应目录的请求配置

具体的方法注释：
https://github.com/diwand/YapiIdeaUploadPlugin/wiki/%E5%BF%AB%E9%80%9F%E4%BD%BF%E7%94%A8

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：/a/570148.html

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

echart图标区域背景

echart图标区域背景

效果图&#xff1a; 代码实例&#xff1a; let option {calculable: true,legend: {orient: vertical,top: 10%,left: right},tooltip: {show: true,formatter: {a} {b} : {c} },xAxis: [{type: category,data: Array.from({ length: 12 }).map((a, index) > ${index 1}月…
阅读更多...
MySQL、Oracle查看最大连接数和当前连接数

MySQL、Oracle查看最大连接数和当前连接数

文章目录 1. MySQL2. Oracle 1. MySQL -- 查看最大连接数 show variables like max_connections; select max_connections; -- select * from performance_schema.session_variables where VARIABLE_NAME in (max_connections); -- select * from performance_schema.global…
阅读更多...
DFS与回溯专题：二叉树的最大深度

DFS与回溯专题：二叉树的最大深度

DFS与回溯专题&#xff1a;二叉树的最大深度 题目链接: 104.二叉树的最大深度 题目描述 代码思路 设置两个变量&#xff0c;max来记录最大值&#xff0c;sum来记录路径的节点数量。利用dfs对二叉树进行搜索&#xff0c;遇到节点&#xff0c;则sum1&#xff1b;遇到叶子节点&…
阅读更多...
【网络编程】网络编程中的基本概念及Java实现UDP、TCP客户端服务器程序（万字博文）

【网络编程】网络编程中的基本概念及Java实现UDP、TCP客户端服务器程序（万字博文）

系列文章目录 【网络通信基础】网络中的常见基本概念 【网络编程】网络编程中的基本概念及Java实现UDP、TCP客户端服务器程序&#xff08;万字博文&#xff09; 【网络原理】UDP协议的报文结构 及 校验和字段的错误检测机制&#xff08;CRC算法、MD5算法&#xff09; 文章目…
阅读更多...
大模型 AI 框架昇思 MindSpore 2.3.RC1 发布，训练、推理性能大幅提升，JIT 编译强化

大模型 AI 框架昇思 MindSpore 2.3.RC1 发布，训练、推理性能大幅提升，JIT 编译强化

经过社区开发者们几个月的开发与贡献&#xff0c;现正式发布昇思 MindSpore2.3.RC1 版本&#xff0c;通过多维混合并行以及确定性 CKPT 来实现超大集群的高性能训练&#xff0c;支持大模型训推一体架构&#xff0c;大模型开发训练推理更简、更稳、更高效&#xff0c;并在训推一…
阅读更多...
Golang | Leetcode Golang题解之第46题全排列

Golang | Leetcode Golang题解之第46题全排列

题目&#xff1a; 题解&#xff1a; func permute(nums []int) [][]int {var (n len(nums)dfs func(vals []int) // 已选择数 排列为vals 后续回溯继续选择 直至选完ans [][]int)dfs func(vals []int) {//边界if len(vals) n {ans append(ans, vals)}//转移 枚举选哪个f…
阅读更多...
Navicat和MySQL的安装、破解以及MySQL的使用（详细）

Navicat和MySQL的安装、破解以及MySQL的使用（详细）

1、下载 Navicat Navicat 官网&#xff1a;www.navicat.com.cn/ 在产品中可以看到很多的产品&#xff0c;点击免费试用 Navicat Premium 即可&#xff0c;是一套多连数据库开发工具&#xff0c;其他的只能连接单一类型数据库 点击试用 选择系统直接下载 二、安装 Navicat 安…
阅读更多...
wsl2 中docker安装完毕后无法正常启动

wsl2 中docker安装完毕后无法正常启动

wsl2 中docker安装完毕后无法正常启动 1、背景2、目标3、环境4、原因4、操作5.1、查看配置5.2、 切换配置5.3、启动docker5.4、验证docker 1、背景 在win10中安装wsl2体验linux操作系统&#xff0c;按照docker官网步骤安装&#xff0c;安装完毕后面提示 $ docker ps Cannot co…
阅读更多...
ChatGPT实战100例 - (18) 用事件风暴玩转DDD

ChatGPT实战100例 - (18) 用事件风暴玩转DDD

文章目录 ChatGPT实战100例 - (18) 用事件风暴玩转DDD一、标准流程二、定义目标和范围三、准备工具和环境四、列举业务事件五、 组织和排序事件六、确定聚合并引入命令七、明确界限上下文八、识别领域事件和领域服务九、验证和修正模型十、生成并验证软件设计十一、总结 ChatGP…
阅读更多...
淘宝扭蛋机小程序开发：开启趣味购物新篇章

淘宝扭蛋机小程序开发：开启趣味购物新篇章

随着移动互联网的迅猛发展&#xff0c;用户对于购物体验的需求也在不断升级。淘宝作为国内领先的电商平台&#xff0c;始终致力于为用户创造更加新颖、有趣的购物环境。为了满足广大用户的期待&#xff0c;淘宝精心打造了一款全新的扭蛋机小程序&#xff0c;旨在为用户带来前所…
阅读更多...
37. UE5 RPG创建自定义的Ability Task

37. UE5 RPG创建自定义的Ability Task

在前面的文章中&#xff0c;我们实现了一个火球术的一些基本功能&#xff0c;火球术技能的释放&#xff0c;在技能释放后&#xff0c;播放释放动画&#xff0c;在动画播放到需要释放火球术的位置时&#xff0c;将触发动画通知&#xff0c;在动画通知中触发标签事件&#xff0c;…
阅读更多...
JetBrains RubyMine v2024.1 安装教程 (Rails/Ruby集成开发环境)

JetBrains RubyMine v2024.1 安装教程 (Rails/Ruby集成开发环境)

前言 JetBrains RubyMine是一款杰出而全面的Ruby代码编辑器&#xff0c;能够深入识别动态语言的细节&#xff0c;为用户提供智能编码辅助功能。它能够自动检测错误代码段&#xff0c;并提供智能的编写和修复代码的建议&#xff0c;帮助用户进行代码重构。此外&#xff0c;Ruby…
阅读更多...
在Redux Toolkit中使用redux-persist进行状态持久化

在Redux Toolkit中使用redux-persist进行状态持久化

在 Redux Toolkit 中使用 redux-persist 持久化插件的步骤如下: 安装依赖 npm install redux-persist配置 persistConfig 在 Redux store 配置文件中(例如 store.js)&#xff0c;导入必要的模块并配置持久化选项: import { combineReducers } from redux; import { persist…
阅读更多...
Jmeter插件技术：性能测试中服务端资源监控

Jmeter插件技术：性能测试中服务端资源监控

性能测试过程中我们需要不断的监测服务端资源的使用情况&#xff0c;例如CPU、内存、I/O等。 Jmeter的插件技术可以很好的实时监控到服务器资源的运行情况&#xff0c;并以图形化的方式展示出来&#xff0c;非常方便我们性能测试分析。 操作步骤&#xff1a; 1、安装插件管理…
阅读更多...
主打国产算力 广州市通用人工智能公共算力中心项目签约

主打国产算力 广州市通用人工智能公共算力中心项目签约

4月9日&#xff0c;第十届广州国际投资年会期间&#xff0c;企商在线&#xff08;北京&#xff09;数据技术股份有限公司与广州市增城区政府就“广州市通用人工智能公共算力中心”项目进行签约。 该项目由广州市增城区人民政府发起&#xff0c;企商在线承建。项目拟建成中国最…
阅读更多...
后端工程师——Java工程师如何准备面试

后端工程师——Java工程师如何准备面试

在国内，Java 程序员是后端开发工程师中最大的一部分群体，其市场需求量也是居高不下，C++ 程序员也是热门岗位之一，此二者的比较也常是热点话题，例如新学者常困惑的问题之一 —— 后端开发学 Java 好还是学 C++ 好。读完本文后，我们可以从自身情况、未来的发展，岗位需求量…
阅读更多...
【JVM系列】关于静态块、静态属性、构造块、构造方法的执行顺序

【JVM系列】关于静态块、静态属性、构造块、构造方法的执行顺序

&#x1f49d;&#x1f49d;&#x1f49d;欢迎来到我的博客&#xff0c;很高兴能够在这里和您见面&#xff01;希望您在这里可以感受到一份轻松愉快的氛围&#xff0c;不仅可以获得有趣的内容和知识&#xff0c;也可以畅所欲言、分享您的想法和见解。 推荐:kwan 的首页,持续学…
阅读更多...
Java算法 空间换时间（找重复）

Java算法 空间换时间（找重复）

一、算法示例 1、题目&#xff1a;题目&#xff1a;0-999的数组中&#xff0c;添加一个重复的元素&#xff0c;打乱后&#xff0c;找出这个重复元素 代码示例&#xff1a; package com.zw.study.algorithm; import java.util.*; public class XorTest {public static void mai…
阅读更多...
Vue报错 Cannot read properties of undefined (reading ‘websiteDomains‘) 解决办法

Vue报错 Cannot read properties of undefined (reading ‘websiteDomains‘) 解决办法

浏览器控制台如下报错&#xff1a; Unchecked runtime.lastError: The message port closed before a response was received. Uncaught (in promise) TypeError: Cannot read properties of undefined (reading websiteDomains) at xl-content.js:1:100558 此问题困扰了…
阅读更多...
可持续发展：制造铝制饮料罐要消耗多少资源？

可持续发展：制造铝制饮料罐要消耗多少资源？

铝制饮料罐是人们经常使用的日常用品&#xff0c;无论是在购物、午休还是在自动售货机前选择喝什么的时候&#xff0c;很少有人会想知道装他们喝的饮料的罐子到底是如何制成的&#xff0c;或者这些铝罐的原材料是如何进出的。 虽然有化学品和一些合金进入铝饮料罐制造过程或成为…
阅读更多...
最新文章

Copyright @ 2022~2023