IDEA:Idea 集成 EasyYApi 插件实现接口文档的生成与更新

这篇具有很好参考价值的文章主要介绍了IDEA:Idea 集成 EasyYApi 插件实现接口文档的生成与更新。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

我是 ABin-阿斌:写一生代码,创一世佳话,筑一览芳华。如果小伙伴们觉得不错就一键三连吧~

idea easyyapi,开发工具,intellij-idea,java,postman

声明:文章原文来源处:

  • https://blog.csdn.net/weixin_40863968/article/details/122432678
  • https://www.jianshu.com/p/cd915908cb96

一、前言

API 这个词我相信大家都不陌生,平时的工作中也会使用到一些api管理工具,比如:YApiswaggerpostmanapidocshowDocrap2等。今天主要介绍下 YApi 以及在 idea 中集成插件实现自动生成与更新 api 文档。

二、正文

1、YApi 介绍

  • YApi gitee 地址
  • YApi github 地址
  • YApi 官方文档地址

下面摘录部分内容来大致介绍YApi,更加深入及详细的内容请移步到上面的链接进行查看。

1、YApi 平台介绍

idea easyyapi,开发工具,intellij-idea,java,postman

  • YApi 是高效、易用、功能强大的 api 管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API。
  • YApi 还为用户提供了优秀的交互体验,开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。

2、YApi 特性

  • 基于 Json5 和 Mockjs 定义接口返回数据的结构和文档,效率提升多倍
  • 支持 postman,har,swagger 数据导入
  • 扁平化权限设计,即保证了大型企业级项目的管理,又保证了易用性
  • 类似 postman 的接口调试
  • 自动化测试,支持对 Response 断言
  • MockServer 除支持普通的随机 mock 外,还增加了 Mock 期望功能,根据设置的请求过滤规则,返回期望数据
  • 免费开源,内网部署,信息再也不怕泄露了

介绍完 YApi 之后,那么接下来进入正题,来看看怎么实现 Idea 与 YApi 的无缝衔接吧。

先看一下接口文档生成的效果吧:

idea easyyapi,开发工具,intellij-idea,java,postman

接下来我们开始进行同步接口文档的操作:
【第一步】: 打开Idea => File => Settings => Plugins => 搜索 EasyYApi 插件并安装

idea easyyapi,开发工具,intellij-idea,java,postman

【第二步】: 安装完成后重启Idea

【第三步】: 打开Idea => Settings => Other Settings => EasyApi 设置,在 Yapi 这块区域中中的 server表单中输入我们公司或则个人自己的 Yapi 访问地址,比如:http://127.0.0.1:8677

idea easyyapi,开发工具,intellij-idea,java,postman

【第四步】: 找到对应的需要创建或者更新的controller,鼠标右键,单击 Export Yapi

idea easyyapi,开发工具,intellij-idea,java,postman

  • 第一次执行Export Yapi 会弹出一个框让我们输入Token,如下图:`

idea easyyapi,开发工具,intellij-idea,java,postman

注意: 上图中的Token来源在 Yapi 服务界面【test】分组下的【test-yapi】项目设置中,【test】分组以及【test-yapi】项目都是我提前创建好的,各位可以在自己创建的项目中找到设置 => token 配置面板获取 Token

idea easyyapi,开发工具,intellij-idea,java,postman

经过上面四步,我们的文档就一键同步到了 YApi , 以后如果controller中接口有变动则再次执行上文中的【第四步】即可同步最新接口到 YApi了


下面是对应的测试代码,通过代码对照这看生成的接口文档可以更加准确的了解Yapi额

controller:

/**
 * 测试 Yapi Controller
 *
 * @author maodudu
 * @version 1.0
 * @date 2022/6/19 21:16
 */
@RestController
public class TestYapiController {

    /**
     * 测试 yapi
     * @param id id
     * @return 结果
     */
    @PostMapping("/yapi/test/{id}")
    public TestYapiVO test(@PathVariable("id") String id){
        return null;
    }
} 

返回结果TestYapiVO :

/**
 * 测试Yapi VO
 *
 * @author maodudu
 * @version 1.0
 * @date 2022/6/19 21:17
 */
public class TestYapiVO {
    /**
     * 名称
     */
    private String name;

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

    /**
     * 性别
     */
    private SexEnum sex;

    /**
     * 资产
     */
    private BigDecimal money;

    /**
     * 朋友列表
     */
    private List<FriendBO> friends;

    /**
     * 朋友BO
     */
    public static class FriendBO {
        /**
         * 朋友名称
         */
        private String friendName;

        /**
         * 朋友性别
         */
        private SexEnum friendSex;
    }
} 

性别枚举类:

/**
 * 性别枚举类
 *
 * @author maodudu
 * @version 1.0
 * @date 2022/6/19 21:27
 */
public enum SexEnum {
    /**
     * 男
     */
    MAN,

    /**
     * 女
     */
    WOMAN,

    ;

} 

3、更新单个API

在上文的基础上,如果有一个controller中有多个接口,我们只想更新其中某一个接口应该怎么操作呢?

【步骤一】: 在对应controller 鼠标右键,单击 Export Api

idea easyyapi,开发工具,intellij-idea,java,postman

【步骤二】: 在弹出的面板中按需选择要更新的接口,回车即可

idea easyyapi,开发工具,intellij-idea,java,postman


扩展知识点:

  • 当我们第一次执行上文中的【第四步】同步接口到 YApi,我们输入Token之后,我们的 idea 中会对其进行保存,可通过 Idea => Settings => Other Settings => EasyApi 面板查看

idea easyyapi,开发工具,intellij-idea,java,postman文章来源地址https://www.toymoban.com/news/detail-807002.html

  • 注意: controller.java 文件必须要有文件注释,文件中的方法需要添加注解 @RequestMapping/@PostMapping 等任意一个,不添加无法识别方法为接口方法 。就算父类方法添加了注解 @RequestMapping/@PostMapping 也无法识别,方法必须添加方法注释(接口名称就是根据方法注释生成)
    idea easyyapi,开发工具,intellij-idea,java,postman

2、postman方式

1、配置

  • 在下方图片中 Postman > token 位置配置 Postman 中项目对应的 token Postman token获取Postman Integrations Dashboard
    idea easyyapi,开发工具,intellij-idea,java,postman

2、使用

  • 右键Controller类 > Generate > Export Postman
    idea easyyapi,开发工具,intellij-idea,java,postman

其他配置方式

1、第一步:

  • Easy Yapi 提供了额外使用的配置文件(以设置 api 指定返回值为例)
  • 在项目根路径下添加 yapi.config 文件,其格式为 properties 格式,官方支持的 文件名及格式如下 文档地址:EasyYapi
    idea easyyapi,开发工具,intellij-idea,java,postman

第二步:

  • 加载外部的配置文件,可以是内外网可访问文件或本地文件
    idea easyyapi,开发工具,intellij-idea,java,postman
  • 文件内容如下(两种模式二选其一,推荐使用 link 模式,与Java注释一致,可链接)
# 支持设置返回类型 package 模式(不建议)
method.return=#real_return
# 支持设置返回类型 link 模式(建议)
method.return[#real_return]=groovy:helper.resolveLink(it.doc("real_return"))
  • 官方文档位置:method_return 新增配置的使用方式
    idea easyyapi,开发工具,intellij-idea,java,postman

到了这里,关于IDEA:Idea 集成 EasyYApi 插件实现接口文档的生成与更新的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • IDEA好用插件:MybatisX快速生成接口实体类mapper.xml映射文件

    目录  1、在Idea中找到下载插件,Install,重启Idea  2、一个测试java文件,里面有com包  3、在Idea中添加数据库 --------以Oracle数据库为例  4、快速生成entity-service-mapper方法  5、查看生成的代码  6、自动生成(增删查改)在TestMapper中快速编写代码 1、在Idea中找到下载插件,Ins

    2024年02月02日
    浏览(59)
  • 【Docker】11、IDEA集成Docker插件实现一键部署SpringBoot项目

    日常开发项目的过程中,我们每次需要部署线上的时候,都需要安装一大堆的运行环境,例如:JDK、MySQL、Redis 等,非常花费时间、我们可以使用 Docker 的容器技术,方便快捷地搭建项目启动所需要的运行环境,本文介绍在开发工具 Idea 中安装 Docker 插件实现一键部署 SpringBo

    2024年02月09日
    浏览(42)
  • IDEA集成Apipost Helper实现一键部署接口(避免参数注释)

    先说好处: 1.一次性导入所有接口,不要一个一个扒。 2.对于字段的注释不要一个一个的去手写,映射实体类,自己上传(最重要)。 3.目录自动归类划分,避免接口混乱。 首先,我们打开idea选择文件进入设置,选择插件,安装我们的Apipost-Helper,英文路径就是在IDEA Settin

    2024年02月09日
    浏览(52)
  • IDEA集成微软TFS插件

    IDEA版本控制TFS的插件有两个 TFS Azure DevOps 其中TFS已经停止更新,需要通过网页端下载离线安装。 最新的TFS插件版本只支持到IDEA2019.3的版本,同时缺少一些想要的功能,例如在添加.tfignore文件并配置后插件不会生效,版本控制窗口依旧会看到许多的IDEA配置文件或项目编译的文

    2024年02月06日
    浏览(62)
  • idea集成测试插件替代postman

    idea集成测试插件替代postman 兄弟萌,你再测试接口是否无bug是否流畅的时候是否还在使用“postman”来回切换进行测试呢? 页面切换进行测试,有没有感觉很麻烦呢? 打开postman,输入接口地址,有没有感觉很麻烦呢? 输入地址就算了,还要设置一系列参数,token,请求参数等

    2024年02月06日
    浏览(44)
  • Idea集成ChatGPT插件---AI帮你写代码

    现在chatGtp非常火,对于程序员来说chatgtp不仅可以帮我们快速查阅资料,还能帮我们写代码,在idea中集成chatGtp插件的话,我们写代码可以分分钟起飞,再也不用打开浏览器查找资料啦,插件还能帮我们构建一些基础代码,算法代码,还能帮我们纠错和代码优化,简直碉堡了

    2024年02月11日
    浏览(50)
  • IDEA 集成 Docker 插件一键部署 Spring Boot 应用

    🚀 作者主页: 有来技术 🔥 开源项目: youlai-mall 🍃 vue3-element-admin 🍃 youlai-boot 🌺 仓库主页: Gitee 💫 Github 💫 GitCode 💖 欢迎点赞 👍 收藏 ⭐留言 📝 如有错误敬请纠正! 随着容器化技术的崛起,Docker成为了现代软件开发的关键工具。在Java开发中,Spring Boot是一款备受

    2024年02月05日
    浏览(46)
  • postman也不行!IDEA接口调试插件

    Postman是大家最常用的API调试工具,那么有没有一种方法可以不用手动写入接口到Postman,即可进行接口调试操作?今天给大家推荐一款IDEA插件:Apipost Helper,写完代码就可以调试接口并一键生成接口文档!而且还可以根据已有的方法帮助您快速生成 url 和 params。更重要的是他

    2024年02月20日
    浏览(47)
  • 装上这个插件,你就能一键生成接口文档

    当有接口对接需求的时候,开发终于不用再担心 API 文档难写了,也不用再一个个接口文档重新写!安装这个 IDEA 插件,可以一步将文档导入到 Postcat。 这款插件操作简单,容易上手,能够 让开发者省去 API 文档编写的工作,更专注于开发。 插件通过分析用户注释进行接口解

    2023年04月22日
    浏览(46)
  • idea一键自动生成对象所有get、set方法。idea插件:GenerateAllSetter

    idea中有一款插件能够一键自动生成对象所有的get、set方法,有助于我们开发者提升开发效率的插件,非常简单实用。 插件名: GenerateAllSetter 。 该插件作用是可以快速针对已有的model实体对象的属性生产get、set代码,免去开发者在开发过程中get、set属性值时还需要去实体对象

    2024年02月11日
    浏览(51)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包