API 文档

Swagger 提供一系列用于生成、可视化和维护 API 文档的解决方案,从而省去了 API 文档的手动工作。

在 API Hub 中文档化 API

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

从您的 API 设计生成文档

随着 API 功能的增长,维护全面的文档可能会变得具有挑战性。Swagger 通过直接从您的 API 定义自动生成文档来简化此过程,确保一致性和时效性。

用于 API 可见性的 API Hub Portal

用于托管 API 文档的 API Hub Design

用于可视化 API 的 Swagger UI

Documentation From Your API Design
文档化现有 API

如果您的现有 API 缺少定义,Swagger 提供了高效生成它们的工具

  • Swagger Core:一个开源库,可促进从现有 Java 代码库生成 OpenAPI 定义。
  • API Hub Explore:此功能允许您自动生成任何端点的 OpenAPI 定义,从而简化文档编制过程。

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

Swagger Inspector:自动生成 OpenAPI 定义

Documenting Existing APIs

维护多个文档版本

对于具有多个版本的 API,内部和外部使用者都必须能够轻松访问相应的文档。API Hub 的版本控制系统使您能够在现有文档的基础上逐步构建并无缝管理多个版本,确保用户可以访问正确的信息。

试用 API Hub

Maintain Multiple Documentation Versions

功能

API 开发者门户

隆重推出用于门户的 API Hub,该功能允许您创建全面的、面向消费者的文档。这通过提供符合您品牌并满足消费者需求的定制体验,增强了 API 的可发现性并加速了上手过程。

© . All rights reserved.