产品

API文档

APIGit 提供用户友好、主题精美的 API 文档,具有多种查看模式。您可以从 API 存储库历史记录中的任何时间点发布 API 文档,确保您始终可以访问最新版本的文档。此外,您还可以将自己的域指向已发布的文档,从而以您的品牌风格呈现它们。它使您可以轻松地与内部团队和外部合作伙伴共享您的 API 文档,同时保持一致和专业的外观。

优雅清晰的API文档
已发布的 API 文档由两个部分组成:API 规范和 markdown 文档,两者均来自 API 存储库中的文件。您可以将多个 API 文档发布为不同的版本,并在它们之间轻松切换。

API规范的查看模式-默认
API规范文档可以通过不同的方式查看,提供对API的全面了解。支持的模式包括:默认视图、swagger-UI 和原始代码模式。这允许您以最适合您需要的方式查看 API 文档并与之交互。
API Specifications的查看方式-swagger UI方式
在 Swagger UI 模式下,您可以在传统的 swagger 主题中查看 API 文档,提供熟悉且易于使用的界面来理解 API 并与之交互。
API规范查看模式-代码模式
在代码模式下,您可以查看原始 API 规范文件,提供对底层代码的直接访问,以便在必要时轻松查看和进行更改。

Markdown文件
Markdown 文档也包含在已发布的 API 文档中。它们提供了一个理想的位置来展示您的设计概念和 API 背后的业务逻辑。此外,我们还支持 markdown 文档的默认模式和代码模式,这使您可以以最适合您需要的方式查看和审查文档。

自定义域
设置自定义域后,您可以使用 CNAME 记录将您自己的域指向您发布的文档,从而允许您以自己的品牌名称和 URL 显示它们。