APIGit は、API ドキュメントを表示するための柔軟で使いやすいエクスペリエンスを提供します。さまざまなビューアーを簡単に切り替えて、同じドキュメントをさまざまな視点から表示できるため、API とその機能をより深く理解できます。デフォルトのビューアーは、人気のあるオープンソースの Redoc ビューアーを使用して構築されています。このビューアーは、API ドキュメントを簡単にナビゲートして理解できる魅力的でわかりやすいレイアウトを提供します。

Swagger ビューアーは、API ドキュメントを視覚化するための従来の使いやすいオプションです。明確で効率的なナビゲーションを可能にするシンプルで整理されたレイアウトを提供します。さらに、このビューアーはパフォーマンスが最適化されているため、大規模または複雑な API ドキュメントに最適です。シンプルで理解しやすい API ドキュメントを理解してナビゲートするための従来の方法を提供します。

コード ビューアーは、API ドキュメントの未加工の未フォーマット ビューを提供し、ドキュメントの基礎となる構造とフォーマットを詳細に確認できるようにします。このビューアーは、ユーザーが API で使用されている正確なコードとフォーマットを確認できるため、エラーのデバッグに特に役立ちます。さらに、API 開発の専門家にとって、コード ビューアーは API ドキュメントを編集する効率的な方法であり、基になるコードに簡単にアクセスできます。このビューアーは、API ドキュメントをより技術的な方法で理解し、それに変更を加えたい開発者や専門家に最適です。

差分ビューアを使用すると、ユーザーはリポジトリ内の 2 つの異なる API ドキュメントを比較できます。この機能は、自動生成された API ドキュメントに加えられた変更を簡単に確認して理解できるため、サードパーティの統合に特に役立ちます。 API ドキュメントで行われた変更を比較し、更新をよりよく理解するのに役立ちます。これは、更新を確認し、変更をマージし、API ドキュメントの一貫性を確保するための優れたツールです。