ドキュメントにAPIリファレンスを挿入する

OpenAPI仕様から完全なAPIリファレンスを挿入するか、個別の操作やスキーマを選択します

GitBook では、OpenAPI 仕様にあるエンドポイントに関連するページを自動生成できます。これらのページには OpenAPI の操作ブロックが含まれ、あなたと訪問者がエンドポイントをテストしたり、仕様に記載された情報をもとにさらに詳しく調べたりできます。

仕様から追加されたエンドポイントは、仕様が更新されるたびに引き続き更新されます。詳細は 仕様を更新する セクションを参照してください。

仕様から OpenAPI ページを自動作成する

OpenAPI 仕様を 追加した後、ブロックを挿入することでエンドポイントページを生成できます OpenAPI リファレンス Space の目次に。

Space の目次に API リファレンスを挿入します。

1

OpenAPI からページを生成する

エンドポイントページを生成したい Space で、 新規追加... ボタンを Space の下部にある 目次.

ここから、 OpenAPI リファレンス.

2

OpenAPI 仕様を選択

をクリックし、以前アップロードした OpenAPI 仕様を選んでから、 挿入 をクリックして、エンドポイントを自動的に Space に追加します。必要に応じて、すべての OpenAPI スキーマを参照するモデルページを追加することもできます。

3

API 操作を管理する

GitBook は、OpenAPI 仕様とその定義内に設定されたタグに基づいて、ページを自動生成します。

次へ移動します APIリファレンスの構成 OpenAPI 仕様を通じて操作を整理する方法について詳しく知るには

個別の OpenAPI ブロックを追加する

または、仕様から OpenAPI の操作やスキーマを、ドキュメント全体の各ページに個別に追加することもできます。

1

新しい OpenAPI ブロックを追加する

ブロックセレクターを開くには /を押して、OpenAPI を検索します。

2

OpenAPI 仕様を選択

をクリックし、以前アップロードした OpenAPI 仕様を選んでから、 続行 して、使用したいエンドポイントを選択します。

3

挿入したい操作またはスキーマを選択する

ドキュメントに挿入したい操作とスキーマを選び、 挿入.