概要

ApidogでAPIを設計・開発した後、他の同僚と簡単に共有したり、公開したりすることができます。Apidogでは、APIドキュメントをウェブページとして簡単に公開することが可能です。

APIドキュメントの共有

• Apidogでは、定義したAPI仕様からワンクリックで美しいAPIドキュメントを生成できます。詳細はクイック共有をご覧ください。
• 生成されたAPIドキュメントは「試してみる」機能とオンラインコード生成をサポートしています。詳細はAPIドキュメントの表示をご覧ください。
• Apidogでは、APIドキュメントをウェブページに公開するだけでなく、MarkdownとAPIドキュメントを組み合わせてユーザードキュメントの一部とすることもできます。詳細はドキュメントサイトの公開をご覧ください。
• Apidogはドキュメントのナビゲーションバーのカスタマイズ、カスタムドキュメントドメイン、カスタムページURLなどもサポートしています。
• ドキュメント内のフォルダスタイルとクリック動作のカスタマイズも可能です。
• ApidogはマルチバージョンのAPIドキュメントの公開もサポートしています。

:::highlight purple
公開されたドキュメントの例はこちら：https://docs.salla.dev/
:::

2種類のドキュメントの違い

Apidogでは、ドキュメントを公開する方法が2つあります。

1つ目は「クイック共有」で、主にチーム内やチーム間のコラボレーションに使用され、一部のAPIドキュメントを共同作業者と共有することができます。2つ目は「ドキュメント公開」で、ドキュメント全体を公開するために使用されます。