Idea集成Yapi插件实现自动生成接口文档

点击蓝色字关注我们!

一个努力中的公众号

长的好看的人都关注了

6a909735a16fead4e17e982f3c7ff03d.png

前言
    API接口在设计时往往需要编写大量的文档,而且编写完成后往往需要根据实际情况经常改动文档,这使得文档编写维护工作量相对较大,让很多的开发者都很头疼。此外,伴随着接口版本的迭代开发,接口文档也需要同步更新。而且接口开发完成以后,做接口测试会十分不方便,要是遇上接口数量多、参数负载的情况,那不仅不方便,测试工作量会重上加重。

fe44befd90fdf352e6a751c85f0bfacd.png

    Yapi 可以帮助开发者轻松创建、发布和维护不同项目,不同平台的API。有了YAPI,我们可以很方便的测试、管理和维护多个项目的API接口,不像Swagger那样是随应用生和灭的(且线上环境下大多数须关闭)。
    Yapi 是一个独立的服务平台,但是仍需要手动维护相关接口文档,如果项目体量较大,接口繁杂过多就会让后续开发十分痛苦。
    那么这个时候如果可以自动生成相关接口文档,就势必成为了急需品、在Idea中有一款插件"easy-yapi",可以在保持代码零侵入的情况下得到相当完整的api文档, 但是特殊的需求还是需要部分特殊的注释/注解配合与之相对的是, 你可以灵活的运用配置规则来适应你的项目特性以减少代码侵入。

1. Idea安装插件:easy-yapi

2364820334db3cc891824342c13fd7b3.png2. 安装后重启Idea

3. 打开settings、在Other Settings下打开EasyApi菜单,配置Yapi服务器地址(只需要对应的ip与端口即可,不需要具体那个项目)

4775b881c36d5279afb70dbc617d8745.png

4. 打开对应需要生成Yapi文档的Controller、 同时按住Shift + Alt + E、会出现以下弹框

1c74d1a01ec23d18625ddb528afe91fb.png

5. 选中需要生成的接口的方法、点击弹框右上角绿色钩子、会弹出一个输入框,让你输入Yapi对应项目下的token

56f529aaf381cd43c37189e520376851.png

e44ba91ecda100566fe0797738e34905.png

6. 将Yapi上面的token复制、粘贴到Idea的弹框中

833ef705bc204a786a37d0432deafe89.png

7. 点击ok 然后会在控制台打印输入生成结果,生成成功会打印success、如果生成失败:一般是Yapi服务器配置多了项目路径、或者是没有Yapi的操作权限

9b945dfca0eaaf587bff5c75fc5148b3.png

生成成功就会在Yapi上面自动创建好对应的接口文档

59cfb9f79f190c99287a97296657bf44.png

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值