Idea 生成Api插件之 EasyYapi

1、安装插件
2、配置使用Yapi插件
- Yapi 配置
- Yapi 使用
- Postman 配置
- Postman 使用
3、其他额外配置
总结

网上有很多 idea EasyYapi 插件的博客，但是没有介绍额外配置的，最近我们使用到了额外配置，我参考了官方文档，然后记录下，考虑到已经有很多博客了，这里没有对太细的注释中的一些变量做讲解，官方文档上都有EasyYapi，这里主要介绍额外配置使用方式，前序是安装和使用过程。

1、安装插件

2、配置使用Yapi插件

位置：Preferences(Settings) > Other Settings > EasyApi
支持Yapi、postman、swagger

Yapi 配置

在上方图片中 Yapi > server 位置配置Yapi对应地址后

Yapi 使用

右键Controller类 > Generate > Export Yapi
此时提示需要输入token，token获取位置：yapi对应的项目 > 设置 > token设置

Postman 配置

在上方图片中 Postman > token 位置配置Postman中项目对应的token
Postman token获取Postman Integrations Dashboard

Postman 使用

右键Controller类 > Generate > Export Postman

3、其他额外配置

Easy Yapi提供了额外使用的配置文件（以设置api指定返回值为例）

在项目根路径下添加 .yapi.config 文件，其格式为properties格式，官方支持的文件名及格式如下文档地址：EasyYapi
加载外部的配置文件
可以是内外网可访问文件或本地文件
文件内容如下（两种模式二选其一，推荐使用 link 模式，与Java注释一致，可链接）

# 支持设置返回类型 package 模式（不建议）
method.return=#real_return
# 支持设置返回类型 link 模式（建议）
method.return[#real_return]=groovy:helper.resolveLink(it.doc("real_return"))

官方文档位置：method_return
新增配置的使用方式

总结

EasyYapi可扩展点很多，其他各种配置，可参考文档自行配置，这里不过多去逐个讲解，有不懂的小伙伴可评论留言。

Idea 生成Api插件之 EasyYapi相关推荐

自定义maven插件：自动生成API的word文档
继上次开发完Maven插件开发:根据库表生成实体类&根据实体类生成库表之后,博主对开发maven插件喜爱得一塌糊涂.这不,今天给大家带来了<自定义maven插件:自动生成API的word ...
为TypeScript项目生成API文档
为TypeScript项目生成文档使用typedoc为TypeScript项目生成API文档. 1. 使用typedoc生成HTML文档需要安装 typedoc. npm i typedoc 可以 ...
vim 插件_Vim自动生成tags插件vim-gutentag使用方法
在常规的使用ctags生成tag标签文件实现跳转的方式下,每次需要更新tags文件时都需要手工运行 ctags -R 生成当前项目所有源文件对应的tag标签文件. 当工程文件多.文件更新频繁时,上述生 ...
python生成api文档_Django 自动生成api接口文档教程
最近在写测试平台,需要实现一个节点服务器的api,正好在用django,准备使用djangorestframework插件实现. 需求实现一个接口,在调用时,通过传递的参数,直接运行对应项目的自动化 ...
python api接口生成_Django 自动生成api接口文档教程
最近在写测试平台,需要实现一个节点服务器的api,正好在用django,准备使用djangorestframework插件实现. 需求实现一个接口,在调用时,通过传递的参数,直接运行对应项目的自动化 ...
imgcook设计稿生成代码插件
Sketch/PSD/静态图片生成代码插件 imgcook 是专注以各种图像(Sketch/PSD/静态图片)为原材料烹饪的匠心大厨,通过智能化手段将各种视觉稿一键生成可维护的 UI 视图代码,期望此 ...
Siki_Unity_7-4_高自由度沙盘游戏地图生成_MineCraft_Uniblocks插件（可拓展）
Unity 7-4 高自由度沙盘游戏地图生成 MineCraft (插件Uniblocks) 任务1&2&3&4 素材 && 课程演示 && 课 ...
MAYA API插件编程--入门篇
MAYA API插件编程--入门篇作者:华文广日期:2010.11.28 我们知道,MAYA是一个基于结点的插件式软件架构,这种开放式的软件架构是非常优秀的,它可以让用户非常方便 ...
如何自动生成 API 接口文档 - 一份详细指南
本篇文章详细教你如何使用 Apifox 的 IDEA 插件实现自动生成接口代码.好处简单总结有以下几点: 自动生成接口文档: 不用手写,一键点击就可以自动生成文档,当有更新时,点击一下就可以自动同步接 ...

Idea 生成Api插件之 EasyYapi

Idea 生成Api插件之 EasyYapi

1、安装插件

2、配置使用Yapi插件

Yapi 配置

Yapi 使用

Postman 配置

Postman 使用

3、其他额外配置

总结

Idea 生成Api插件之 EasyYapi相关推荐

最新文章

热门文章