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

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

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

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

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

～した後で OpenAPI仕様を追加した、エンドポイントページを生成するには、1つの OpenAPI リファレンス セクションの目次に。

セクションの目次にAPIリファレンスを挿入します。

1

OpenAPIからページを生成する

エンドポイントページを生成したいセクションで、 新規追加... セクション下部の 目次.

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

2

OpenAPI仕様を選択

以前アップロードしたOpenAPI仕様を選択します。次に、 ページ構成:

• タグごとに 1 ページ
• オペレーションごとに 1 ページ

モデルページとダウンロードリンクを追加することもできます。 挿入 をクリックしてリファレンスを生成します。

3

API操作を管理する

GitBookは、OpenAPI仕様と、その定義内で設定されたタグに基づいてページを自動生成します。 オペレーションごとに 1 ページを選ぶと、GitBookは生成された操作ページをタグごとにグループ化します。

に移動します OpenAPI レイアウト レイアウトを比較するには、または API リファレンスの構成 タグでページを整理するには。

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

代わりに、仕様内のOpenAPIの操作やスキーマを、ドキュメント全体の各ページに個別に追加できます。

1

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

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

2

OpenAPI仕様を選択

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

3

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

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