生成接口文档并同步到postman

前言

当我们开发需要测试接口时,会遇到以下几个问题

1.如果接口过多,参数过多,一个个参数复制到postman简直能要了我的狗命,重复劳动过多.

2.如果接口过多,参数过多,编写接口文档给测试人员或者前端,又特么要命.

于是这里安利一款idea插件easyyapi,能一键帮我们解决以上问题

GitHub地址

https://github.com/tangcent/easy-yapi

功能特性

• 导出API文档到Postman
• 导出API文档到Yapi
• 导出API文档到Markdown
• 导出RPC文档到Yapi
• 导出RPC文档到Markdown
• 在IDEA中直接发起API请求
• Api DashBoard
• YApi DashBoard

解读一下,第一个就是能直接把接口测试信息同步到你的postman帐号上,直接运行测试即可.

yapi类似 swagger的一个生成接口文档平台.没用过,但是也是可以一键同步过去

第三就很舒服了,可以导出API成markdown格式文件,样式还很好看.

Typora打开markdown文档还可以导出为PDF,简直福利有木有.

再安利一个PDF转word文档的在线地址(https://app.xunjiepdf.com/pdf2word/)

环境

• IDEA
• SpringMVC

安装

idea插件库地址

https://plugins.jetbrains.com/plugin/12458-easyyapi/

或者直接在idea插件中搜索easyyapi

使用

因为我们要同步接口信息到postman,因此我们要先配置postman

先获取密钥

https://web.postman.co/settings/me/api-keys

再配置下token

生成

插件是根据什么生成的呢?

1.路径: @RequestMapping() 识别改注解生成路径,类及方法上

2.请求方式: @PostMapping 或者@GetMapping

3.请求请求协议: @RequestBody则以Json

4.返回响应协议: @RestController 或者 @ResponseBody 返回Json

右键点击生成,或者快捷键alt+insert

效果如下,注意因为这里接口是加了@RequestBody因此为json请求,所以请求体在body中

导出markdown

操作方法和以上一致

不过注意一个问题就是生成选择保存路径时,文件名字会固定为easy-api.md

因此生成多个md文档时记得及时备份改名,否则会被覆盖

Typora支持导出各种格式,在配合在线格式转换工具能很大程度提高我们的效率

https://app.xunjiepdf.com/pdf2word/