发明公开
CN109683886A 一种多元化接口文档生成方法
无效 - 撤回
- 专利标题: 一种多元化接口文档生成方法
- 专利标题(英): A diversified interface document generation method
-
申请号: CN201811433944.2申请日: 2018-11-28
-
公开(公告)号: CN109683886A公开(公告)日: 2019-04-26
- 发明人: 张志江 , 季统凯
- 申请人: 国云科技股份有限公司
- 申请人地址: 广东省东莞市松山湖高新技术产业开发区科汇路1号中科院云计算中心19楼
- 专利权人: 国云科技股份有限公司
- 当前专利权人: 国云科技股份有限公司
- 当前专利权人地址: 广东省东莞市松山湖高新技术产业开发区科汇路1号中科院云计算中心19楼
- 代理机构: 广东莞信律师事务所
- 代理商 陈熙
- 主分类号: G06F8/35
- IPC分类号: G06F8/35 ; G06F8/41
摘要:
本发明涉及Java服务端开发技术领域,特别是一种多元化接口文档生成方法。本发明首先要在模块Controller类头部加入@ApiDoc注释,用来将接口分类,然后在接口入口方法那里加入@ApiOperation,接着设置接口地址、名字、描述、权限、入参类、出参类以及header头部类,最后项目启动的时候,会自动扫描所有需要生成接口文档的方法,并且生成定制化的接口文档。本发明解决了接口文档跟随代码实施同步问题;让开发人员、测试人员以及运维人员可以更清晰、更准确地看懂系统自动生成出来的接口文档。