接口文档技术
郭旭升 Lv6

Swagger

用于生成、描述和调用Restful接口的web服务。 将项目中所有接口展现在页面上,并且可以进行调用和测试服务。

  • 将所有接口展现在页面上,后端程序员就不需要专门为前端使用者编写专门的接口文档。
  • 接口更新后直接修改代码中的Swagger描述就可以生成新文档了。
  • 通过页面可以直接进行接口调用、降低了开发阶段的调试成本。

SpringFox对应Swagger 就像Spring中的IoC对DI 前者是思想、后者是实现。

Knife4j

为MVC框架集成Swagger生成API文档的增强解决方案。

  • 专注于前后端代码分离、微服务架构下使用灵活。
  • 提供Swagger的增强解决方案,不同于之改善前端UI的部分。

Smart-Doc

Swagger在生成api文档需要在接口上添加注解等,这是一种侵入的方式。
smart-doc是一种非侵入的方式
多数情况多数人会选择Swagger + openapi技术栈。

 Comments