Java后端接口自动生成神器 -- EasyYapi插件（Yapi接口管理工具在IDEA里的插件）

2024-04-30 20:07:35

Java后端接口自动生成神器 – EasyYapi插件（Yapi接口管理工具在IDEA里的插件）

一、先看效果

1、生成yapi文档的效果

2、生成postman格式数据并导入接口测试类后的效果（如postman、apifox等工具）

3、生成markdown格式文档的效果

二、安装

1、安装EasyYapi插件

idea的顶部菜单栏选择文件 -> 设置 -> 插件，然后再marketplace里搜索easyYapi安装即可

安装完成后设置底部回出现EasyApi的栏目，选中进行配置修改（我主要是改了下图红框的位置，不修改使用默认配置也可以，自己可以试试使用json5和不适用json5的区别，我更喜欢看json5格式的文档【也是最近才发现有这个格式的】）

2、安装yapi接口文档管理系统

如果只需要在postman等接口工具中使用，可以跳过此步骤
官方部署文档：https://hellosean1025.github.io/yapi/devops/index.html
注意：node.js不要安装最高版本（我安装最高版本时安装yapi失败，node.js重新安装12.x版本后成功）

三、接口编写

接口上的注释自动会生成接口名称和接口的描述信息，实体类里的注释也会自动生成文档里的字段说明

四、生成文档

快捷键：Shift + Alt + E
更多使用教程见官网文档：https://easyyapi.com/index.html

如果选择yapi，首次需要填写一个yapi服务的地址，如：127.0.0.1:3000
然后需要填写项目的token，这个token是yapi服务器新建项目后生成的token

Java后端接口自动生成神器 -- EasyYapi插件（Yapi接口管理工具在IDEA里的插件）相关推荐

java sap总账凭证接口_SAP系统接口自动生成会计凭证且无需记账码的方法与流程...
本发明涉及sap系统接口自动生成会计凭证且无需记账码的方法,属于企业信息化管理技术领域. 背景技术: 在企业信息化管理领域,sap系统接口有着非常重要的意义,它担当着sap系统与其他信息系统的桥梁功能 ...
java注解的开发_使用Java注解开发自动生成SQL
使用注解开发的好处就是减少配置文件的使用.在实际过程中,随着项目越来越复杂,功能越来越多,会产生非常多的配置文件.但是,当配置文件过多,实际维护过程中产生的问题就不容易定位,这样就会徒劳的增加工作量. ...
实体类dao接口mysql_利用MyBatis生成器自动生成实体类、DAO接口和Mapping映射文件...
解决问题: 可利用MyBatis生成器自动生成实体类.DAO接口和Mapping映射文件. 测试环境准备: 新建一个mysql数据库,例如mungerzTest. 生成一张主键为自增ID的学生表: C ...
Java代码实现自动生成产品标签图片(升级版)
上次写过一次Java代码实现自动生成产品标签图片的案例,今天工作中又用到了,再来补充一下. 要求,生成的标签戴上logo标志,也就是加上图片:直接上代码: public static void cre ...
Java使用FreeMarker自动生成Word文档（带图片和表单）
Java使用FreeMarker自动生成Word文档(带图片和表单) 1 背景 2 目标效果 3 创建Word模板 3.1 创建模板文档 3.2 转换模板文档 3.3 处理模板文档中的占位符 3.4 ...
sqlaction 更新至 v0.2.1.0，自动生成 JDBC 代码的数据库持久层工具
开发四年只会写业务代码,分布式高并发都不会还做程序员? 0.2.1.0 2019-04-17 calvin * 新增拦截器"@@STA ...
java 文档自动生成的神器 idoc
写文档作为一名开发者,每个人都要写代码. 工作中,几乎每一位开发者都要写文档. 因为工作是人和人的协作,产品要写需求文档,开发要写详细设计文档,接口文档. 可是,作为一个懒人,平时最讨厌的一件事情就 ...
MyBatis自动生成实体类、DAO接口和Mapping映射文件的代码（逆向工程）
MyBatis属于一种半自动的ORM框架,它需要程序员自己编写sql语句和映射文件,但是编写映射文件和sql语句很容易出错,所以mybatis官方提供了Generator生成器,自动生成DAO接口.实 ...
简单的二维码生成接口,自动生成二维码,返回图片地址
自动生成二维码,返回图片地址本来不想写的,但是怕太久不写这个东西,就要荒废了,就先记录一下简单的东西这里因为,返回地址的时候,通过了nginx ,我试了很多方法都抓取不到对应的IP地址, 就在ng ...

最新文章

热门文章