apidoc&servicedoc实践

Saber | 原创 | 2018-10-25
apidoc 下面内容以项目insurance-2a-broker为例 项目根目录增加文件 .gitlab-ci.yml,提交代码时触发Jenkins任务 trigger_build_doc: stage: deploy only: - develop script: - curl [阅读全文]
ė94次浏览 60条评论 0 apidoc servicedoc doc

API接口文档生成方案调研

Saber | 方案调研 | 2018-05-29
1调研背景 目前存在以下情况: 1)一般开发人员更新接口后,没有同时更新rap,rap上的接口定义普遍存在跟代码不一致的情况。 2)后端开发人员查看别人接口,很难很快地知道接口的作用,以及接口入参和返回结果中每个字段的含义。 3)rap上的mock数据功能不是特别好用。 2 调研结果 为了解决以上问题,调研了主流的三个工具,swagger2、sp [阅读全文]
ė345次浏览 60条评论 0 apidoc 接口文档

Ɣ回顶部