Api接口管理工具选型

Posted on 2021-08-11 Edited on 2025-04-11

在工作中你一定会遇到要提供大量接口供调用方调用，由此写接口文档时开发比较繁琐的事情，如果没有一款合适的api接口的管理工具，那么写接口文档将会是一个很繁琐的工作。像目前比较常用的方案如swagger等方案，由于侵入性太高，需要再代码中引入大量注解参数，还有类似公司用的sosoapi的阉割版发现也不是太契合我的需求。

所以我就找到了两款工具：

1、JApiDoces

https://japidocs.agilestudio.cn/#/zh-cn/?id=%e5%9c%a8controller%e7%b1%bb%e4%b8%8a%e4%bd%bf%e7%94%a8

此工具比较好用只要再接口中注释按照javadoc方式进行注释就可以自动生成markdown、pdf、word文档

但是不能mock和api调用接口测试，好多功能需要插件接口开发

2、Yapi

http://yapi.smart-xwork.cn/doc/documents/index.html

此管理工具除了实现1的功能外还提供mock,api接口调用等功能比较全面

另外配合IDEA中Api Generator插件一键可以讲RESTful接口自动上传并托管再内网部署的YApi服务器上;然后通过yapi可以对接口进行接口调用，提供数据的导入和导出（可以导入swagger、postman、json等数据，导出提供导出markdown、html，json，swagger格式数据）。

步骤如下：