API 文档

Swagger 通过一系列解决方案来生成、可视化和维护 API 文档，从而减少了 API 文档的手动工作。

在 SwaggerHub 中记录 API

正在寻找开源 UI？ 下载 Swagger UI

从您的 API 设计生成文档

您的 API 功能的演变是不可避免的，但是维护 API 文档的麻烦不必如此。Swagger 工具简化了生成和维护 API 文档的难题，确保您的文档随着 API 的发展而保持最新状态。

用于 API 可见性的 SwaggerHub 门户

用于托管 API 文档的 SwaggerHub

用于可视化 API 的 Swagger UI

Documentation From Your API Design
记录现有 API

文档可以从 API 定义自动生成。但是，如果您的现有 API 没有定义怎么办？我们提供开源的 Swagger Core 来从现有的 (Java) API 代码生成 OpenAPI 定义。如果您想加快此过程，您和您的团队也可以尝试使用 Swagger Inspector 来自动为任何端点生成 OpenAPI 文件。

Swagger Core 从现有 (Java) API 代码生成 OpenAPI

Swagger Inspector 自动生成 OpenAPI 定义

Documenting Existing APIs

维护多个文档版本

您的 API 的内部和外部使用者应该可以轻松发现您的 API 的所有可用版本，以及有关如何使用它的必要信息。使用 SwaggerHub 的版本控制系统，逐步构建在现有 API 文档之上，或维护 API 的多个版本的文档。

探索 SwaggerHub 的文档版本控制

Maintain Multiple Documentation Versions

工具

可自定义的 API 开发者门户

SwaggerHub 的最新功能 SwaggerHub 门户允许您创建全面的面向消费者的文档，从而更容易发现和更快地加入您的 API。

试用 SwaggerHub 门户

API 文档资源

文章 API 文档的最佳实践 我们详细介绍了一些好的实践，以帮助您的团队创建出色的 API 文档 电子书 记录您的现有 API：使用 OpenAPI 和 Swagger 轻松进行 API 文档编制 像 OpenAPI（以前的 Swagger 规范）、RAML 和 API 蓝图这样的 API 描述格式改变了团队的工作方式 ... 网络研讨会 使用 OpenAPI 规范和 Swagger 工具进行 API 文档编制 在此网络研讨会中，我们将研究 OpenAPI 规范在记录 API 中的作用...

自信地扩展您的 API 设计

设计

根据基于规范的标准设计和建模 API

构建

使用几乎任何语言为您的 API 构建稳定、可重用的代码

文档

通过交互式 API 文档改善开发人员体验

测试

对您的 API 执行简单的功能测试，而无需额外开销

标准化

在您的 API 架构中设置并强制执行 API 样式指南