Apidog は、API 仕様をプロフェッショナルでインタラクティブなドキュメントへ変換する強力な公開機能を提供します。チーム内で API を共有する必要がある場合でも、包括的なドキュメントを一般公開する場合でも、Apidog は、クイック共有リンクから独自ドメインを使用した完全にカスタマイズされたドキュメントサイトまで、ニーズに合わせた柔軟なオプションを提供します。API ドキュメントを共有する#
Apidog では、API ドキュメントを共有および公開するための複数の方法を提供しており、それぞれ異なる ユースケースに合わせて設計されています。クイック共有: 定義済みの API 仕様からワンクリックで美しい API ドキュメントを生成します。迅速なコラボレーションに最適です。 ドキュメントサイト: Markdown コンテンツと API ドキュメントを組み合わせた包括的なドキュメントサイトを公開し、完全なユーザーガイドを作成できます。 カスタムナビゲーション: ユーザー体験を向上させるために、ドキュメントのナビゲーションバーをカスタマイズできます。 カスタムドメイン: プロフェッショナルなブランディングのために、ドキュメントを独自ドメインに紐付けできます。 対応している API 技術#
Apidog は、事実上あらゆる API 技術のドキュメント化を包括的にサポートしています。従来の REST API、最新の GraphQL、リアルタイム WebSocket 接続、エンタープライズ向け SOAP サービスのいずれを扱っている場合でも、Apidog が対応します。対応技術には次が含まれます: REST、SOAP、GraphQL、gRPC、WebSocket、SSE など。さまざまな API タイプを効果的にドキュメント化する方法を確認するには、ドキュメントのベストプラクティスと実際の API 例のコレクションをご覧ください。クイック共有とドキュメント公開#
Apidog では、異なるシナリオに最適化された 2 つの公開方法を提供しています。それぞれの違いを理解することで、ニーズに合った適切な方法を選択できます。クイック共有は、迅速で柔軟なコラボレーションを目的として設計されています。開発中に特定の API をチームメンバーや外部パートナーと共有する場合に最適です。ドキュメント公開は、完全なカスタマイズ機能を備えた、プロフェッショナルで一般公開向けのドキュメントサイトを作成するために構築されています。機能比較#
| 機能 | クイック共有 | ドキュメント公開 |
|---|
| 一部の API を公開 | ✓ 対応 | プロジェクト全体のみ |
| カスタムドメイン | ✗ 非対応 | ✓ 対応 |
| カスタムナビゲーション | ✗ 非対応 | ✓ 対応 |
| カスタムカラーとロゴ | ✗ 非対応 | ✓ 対応 |
| API Hub への公開 | ✗ 非対応 | ✓ 対応 |
内部コラボレーションや迅速な API レビューには クイック共有を使用してください。一般公開向けのプロフェッショナルでブランド化されたドキュメントサイトが必要な場合は、ドキュメント公開を使用してください。
