OpenAPI 仕様から完全な API リファレンスを挿入するか、個別の operation や schema を選択する
GitBook を使うと、OpenAPI 仕様に含まれるエンドポイントに関連するページを自動生成できます。これらのページには OpenAPI の操作ブロックが含まれ、あなたや訪問者がエンドポイントをテストしたり、仕様に記載された情報に基づいてさらに詳しく調べたりできます。
仕様から追加したエンドポイントは、仕様が更新されるたびに引き続き更新されます。詳しくは 仕様を更新する セクションを参照してください。
OpenAPI 仕様を 追加したら、次のものを挿入することでエンドポイントページを生成できます OpenAPI リファレンス Space の目次に。
OpenAPI からページを生成する
エンドポイントページを生成したいスペースで、 新規追加... ボタンをスペースの下部にある 目次.
ここから OpenAPI リファレンス.
OpenAPI 仕様を選択
以前アップロードした OpenAPI 仕様を選択し、 挿入 をクリックして、エンドポイントをスペースに自動的に追加します。必要に応じて、すべての OpenAPI スキーマを参照するモデルページを追加することもできます。
API 操作を管理する
GitBook は、OpenAPI 仕様とその定義内で設定されたタグに基づいて、ページを自動生成します。
次へ移動します API リファレンスの構成 を参照して、OpenAPI 仕様を通じて操作を整理する方法について詳しく学んでください。
または、仕様内の OpenAPI 操作やスキーマを、ドキュメント内の各ページに個別に追加することもできます。
新しい OpenAPI ブロックを追加する
次を押してブロックセレクターを開きます /、OpenAPI を検索します。
以前アップロードした OpenAPI 仕様を選択し、 続行 して、使用したいエンドポイントを選択します。
挿入したい操作またはスキーマを選択する
ドキュメントに挿入したい操作とスキーマを選択し、 挿入.
最終更新 4 か月前
役に立ちましたか？
