APIバージョンの公開

プロジェクト内でAPIバージョンを作成した後、「Share Docs -> Publish」に移動して公開することができます。APIバージョンが公開されると、その内容はAPIドキュメントリンクを通じてアクセス可能になります。

公開するAPIバージョンを追加するには、Release Versionの横にあるAddボタンをクリックします。

Source: プロジェクト内の既存のAPIバージョンから選択します。公開されたドキュメントには、選択したAPIバージョンの内容が表示されます。

Display Version Number: 公開ドキュメント上でユーザーに表示されるバージョン番号です。

Environments: ドキュメント内で読者がデバッグを開始できる環境です。

Slug: オンラインAPIドキュメントのリンクに追加される一意の識別子です。例: https://example.apidog.io/2-0-0。

重要: 公開するバージョンを追加すると、それらはリストに表示され、順序を並べ替えることができます。この順序は、オンラインドキュメント上でユーザーにバージョンがどのように表示されるかを決定します。最初にリストされたバージョンがデフォルトのバージョンです。ユーザーがSlugを指定せずにオンラインドキュメントにアクセスした場合、このデフォルトバージョンにリダイレクトされます。

リリースバージョンが正常に設定されたら、Publish Statusの横にあるPublishをクリックしてドキュメントを公開します。これにより、ユーザーはオンラインリンクを通じて公開されたドキュメントにアクセスでき、すべてのリリースされたバージョンを表示し、異なるバージョン番号をクリックして対応する内容にアクセスできます。