APIドキュメントの公開、アップデート、公開取り消しを行います。
このタスクについて
API Portalタブ内のAPIのリストから、リポジトリーに公開されているAPIドキュメントを管理できます。
手順
-
新しいAPIバージョンをポータルに公開するには、[Publish] (公開)ボタンをクリックします。
-
公開済みの同じドキュメントを再公開するには、[Republish] (再公開)ボタンをクリックします。
-
APIが前回の公開後に変更された場合は、[Update] (アップデート)ボタンをクリックして、アップデートされたドキュメントをリポジトリーに送信します。
最後の変更が公開されると、最終アップデート日の横にこのアイコン
が表示されます 。最後の公開後にAPI定義がアップデートされると、このアイコン
が表示されます: 。
-
リポジトリーからAPIバージョンを削除するには、[Unpublish] (公開を取り消し)をクリックします。
-
リポジトリーに公開せずにAPIバージョンを公開済みとしてマークするには、ボタンをクリックし、[Mark as published] (公開済みとしてマーク)をクリックします。
-
ドキュメントをリポジトリーから削除せずにAPIバージョンを公開取り消しとしてマークするには、ボタンをクリックし、[Mark as unpublished] (公開取り消しとしてマーク)をクリックします。