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

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

GitBook は、OpenAPI 仕様にあるエンドポイントに関連するページを自動的に生成できます。これらのページには OpenAPI の操作ブロックが含まれ、あなたや訪問者が仕様に基づいてエンドポイントをテストしたりさらに探索したりできます。

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

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

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

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

1

OpenAPI からページを生成する

エンドポイントページを生成したいスペースで、 新規追加... ボタンをスペースの下部からクリックします。 の目次.

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

2

OpenAPI 仕様を選択

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

3

API 操作を管理する

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

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

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

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

1

新しい OpenAPI ブロックを追加

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

2

OpenAPI 仕様を選択

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

3

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

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