项目场景
目前负责一个外部的项目,类似于总部提供接口给分公司的开发。由于内网限制(网络安全)某些原因导致swagger等接口文档不能访问。于是考虑使用 ApiFox。
使用原因
网上综合评论都是 效率。
查看 ApiFox 官方文档发现该工具对 idea 支持度挺高。可以通过安装插件实现接口文档的自动生成。
具体步骤上方的链接有详细的图文步骤说明,不再赘述。
主要是看重:
-
引入插件之后,通过右键一键生成该接口的文档,它不香吗?
-
然后通过点击在线分享,即可提供一个外部访问的接口文档,并且已自动生成 请求体参数说明 和 返回体参数说明。否则如果您的接口有几百个参数的话,然后手动填入相关注解,那将是灾难性的工作量。