Skip to main content

swagger

David LiuLess than 1 minute

swagger

在线文档

  1. 及时性(接口变更后,能够及时准确地通知相关前后端开发人员)
  2. 规范性(并且保证接口的规范性,如接口的地址,请求方式,参数及响应格式和错误信息)
  3. 一致性(接口信息一致,不会出现因开发人员拿到的文档版本不一致,而出现分歧)
  4. 可测性(直接在接口文档进行测试,以方便理解业务)

kife4j

knife4i 是为 ava MVC 框架集成 Swaggers 生成 Api 文档的增强解决方案。

knife4j 属于 service 模块公共资源,因此我们集成到 service-util 模块

Docket

接口的分组,如管理员系统的接口、用户系统的接口