Easy Yapi插件使用详情

前言

上一篇文章和大家一起一步步的本地安装了Yapi,有兴趣的可以点击Mac Yapi 本地安装踩坑教程

这篇文章我们来谁谁Easy Yapi插件的使用, 也是当初安装Yapi的目的就是为了使用Easy Yapi插件。

正文

安装

Idea 插件的安装步骤这里不细说了,大家如何不清楚的,可以看我历史文章,插件名字就叫Easy Yapi,如下图所示

 配置

安装成功后,再下图中设置Yapi配置

 从配置中可以看出来,这个插件支持3种接口平台:PostMan、Yapi、Markdown,今天我们将其中的一种Yapi。

在中间的地方,找到Yapi的模块,在server框填入Yapi的服务地址跟目录,如上图所示,填入http://127.0.0.1:3001/

token内容需要我们到Yapi上复制,如下图所示:

 进入Yapi我们的项目,选择设置、token配置,点击复制的按钮,然后填入到插件里,根据需要再勾选其他选项,例如feign use json5 选择all等等。

最后点击apply 、ok。

使用

在我们要生成接口的controller文件右键,弹出框选择Export Yapi ,弹出框填入刚才的token,显示下图所示,说明生成成功了,

 我们打开Yapi该项目刷新页面

自动将Controller类设置为分类名称,备注设置接口显示名称,看一下代码的写法,

 注意点:只有在方法上标记了@RequestMapping类似的注解才会生成接口,有一种情况,例如这个接口即是feign接口的实现类,又是controller接口,那么我们在Controller类方法上是可以省略Maping注解的,只要在feign接口层上标记即可,那么这种情况下,插件是不会给你生成接口文档的,但是当你在配置页面勾选了feign选项的情况下,我们在Controller层生成接口文档以后,会二次弹窗,输入token后,就会自动给你将feign接口中的方法生成接口文档。

猜你喜欢

转载自blog.csdn.net/zanpengfei/article/details/127011150
今日推荐