不同模式查看API文档

APIGit

2022-11-15

APIGit 为查看 API 文档提供了灵活且用户友好的体验。您可以轻松地在不同的查看器之间切换以从不同的角度查看同一文档,从而让您更深入地了解 API 及其功能。默认查看器是使用流行的开源 Redoc 查看器构建的,它提供了一个有吸引力且直观的布局,可以轻松浏览和理解 API 文档。

API main

Swagger 查看器是用于可视化 API 文档的经典且易于使用的选项。它提供了一个简单、整洁的布局,允许清晰高效的导航。此外,此查看器针对性能进行了优化,使其成为大型或复杂 API 文档的理想选择。它提供了一种理解和导航 API 文档的传统方式,这种方式简单易懂。

swagger UI

代码查看器提供 API 文档的原始且未格式化的视图,让用户可以详细了解文档的底层结构和格式。此查看器对于调试错误特别有用,因为它允许用户查看 API 中使用的确切代码和格式。此外,对于 API 开发专家而言,代码查看器可以成为编辑 API 文档的有效方式,提供对底层代码的轻松访问。对于希望以更技术性的方式理解 API 文档并对其进行更改的开发人员和专家来说,此查看器是最佳选择。

Code viewer

Diff 查看器允许用户比较存储库中的两个不同的 API 文档。此功能对于第三方集成特别有用,因为它允许轻松查看和理解对自动生成的 API 文档所做的任何更改。它有助于比较 API 文档中所做的更改并以更好的方式理解更新。它是审查更新、合并更改和确保 API 文档一致性的好工具。

diff viewer