接口文档管理系统首推swagger在controller层进行配置,有@Api、@ApiOperation、@ApiImplicitParam、@ApiModel等注解;
但由于其的不安全性建议不首先用swagger。
其次有eolinker、mindoc等于项目分开的文档管理系统。也可以自己写文档做好备份或在线备份。主要内容是入参和出参及返回值,接口的在线和本地或局域网的接口路径。
接口文档管理
最新推荐文章于 2024-07-20 11:53:32 发布
接口文档管理系统首推swagger在controller层进行配置,有@Api、@ApiOperation、@ApiImplicitParam、@ApiModel等注解;
但由于其的不安全性建议不首先用swagger。
其次有eolinker、mindoc等于项目分开的文档管理系统。也可以自己写文档做好备份或在线备份。主要内容是入参和出参及返回值,接口的在线和本地或局域网的接口路径。