api 接口文档工具 swagger

发表于 分类于 阅读次数： 本文字数： 618 阅读时长 ≈ 1 分钟

office site
https://swagger.io/solutions/api-design/
https://swagger.io/tools/

待学习文档
https://www.ibm.com/developerworks/cn/web/wa-use-swagger-to-document-and-define-restful-apis/index.html

Swagger 能成为最受欢迎的REST APIs文档生成工具之一，有以下几个原因：

  • 可以生成一个具有互动性的API控制台，开发者可以用来快速学习和尝试API。
  • 可以生成客户端SDK代码用于各种不同的平台上的实现。
  • 文件可以在许多不同的平台上从代码注释中自动生成。
  • 有一个强大的社区，里面有许多强悍的贡献者。

文档提供了一个方法，使我们可以用指定的 JSON 或者 YAML 摘要来描述你的 API，包括了比如 names、order 等 API 信息。

你可以通过一个文本编辑器来编辑 Swagger 文件，或者你也可以从你的代码注释中自动生成。各种工具都可以使用 Swagger 文件来生成互动的 API 文档。

如果你后台开发，提供restful接口给前端。建议你使用swagger-ui提供restful的接口文档描述。
如果你是接口设计者，建议你使用Swagger Editor设计。
如果你是接口调用方，想快速生成接口调用代码，很简单，你只需要使用Swagger Editor生存client代码就行了，十分方便。