製品
API ドキュメント
APIGit は、さまざまなビュー モードを備えた、ユーザー フレンドリーで美しいテーマの API ドキュメントを提供します。 API リポジトリの履歴の任意の時点から API ドキュメントを公開できるため、ドキュメントの最新バージョンに常にアクセスできます。さらに、公開されたドキュメントに独自のドメインを指定して、ブランドのスタイルでそれらを提示することもできます.一貫性のあるプロフェッショナルなルック アンド フィールを維持しながら、API ドキュメントを内部チームや外部パートナーと簡単に共有できます。
エレガントで明確な API ドキュメント
公開された API ドキュメントは、API 仕様とマークダウン ドキュメントの 2 つのコンポーネントで構成され、どちらも API リポジトリ内のファイルから取得されます。複数の API ドキュメントを異なるバージョンとして公開し、それらを簡単に切り替えることができます。
API 仕様の表示モード - デフォルト
API 仕様ドキュメントはさまざまなモードで表示できるため、API を包括的に理解できます。サポートされているモードには、デフォルト ビュー、swagger-UI、生コード モードがあります。これにより、ニーズに最も適した方法で API ドキュメントを表示および操作できます。
API 仕様の表示モード - swagger UI モード
Swagger UI モードでは、従来の swagger テーマで API ドキュメントを表示でき、API を理解して操作するための使い慣れた使いやすいインターフェイスを提供します。
API仕様の閲覧モード - コードモード
コード モードでは、未加工の API 仕様ファイルを表示して、基礎となるコードに直接アクセスできるため、レビューや必要に応じた変更が容易になります。
マークダウン ドキュメント
公開された API ドキュメントには、Markdown ドキュメントも含まれています。これらは、API の背後にある設計コンセプトとビジネス ロジックを提示するのに理想的な場所を提供します。さらに、マークダウン ドキュメントのデフォルト モードとコード モードもサポートしているため、ニーズに最適な方法でドキュメントを表示および確認できます。
カスタム ドメイン
カスタム ドメインを設定すると、CNAME レコードを使用して、独自のドメインを公開ドキュメントに向けることができ、独自のブランド名と URL でドキュメントを表示できます。
© 2024 APIGit Inc.