一种多元化接口文档生成方法
摘要:
本发明涉及Java服务端开发技术领域,特别是一种多元化接口文档生成方法。本发明首先要在模块Controller类头部加入@ApiDoc注释,用来将接口分类,然后在接口入口方法那里加入@ApiOperation,接着设置接口地址、名字、描述、权限、入参类、出参类以及header头部类,最后项目启动的时候,会自动扫描所有需要生成接口文档的方法,并且生成定制化的接口文档。本发明解决了接口文档跟随代码实施同步问题;让开发人员、测试人员以及运维人员可以更清晰、更准确地看懂系统自动生成出来的接口文档。
0/0