拡張機能リファレンス

GitBook がサポートする OpenAPI 拡張機能の完全なリファレンス

拡張機能を使用して OpenAPI 仕様を強化できます。つまり、次の文字で始まるカスタムフィールドです。 x- というプレフィックスです。これらの拡張機能を使うと、追加情報を付与し、さまざまなニーズに合わせて API ドキュメントを調整できます。

GitBook では、OpenAPI スペックに追加できるさまざまな拡張機能を通じて、公開サイトでの API の見た目や動作を調整できます。

こちらの ガイドセクション で、OpenAPI 拡張機能を使ってドキュメントを設定する方法の詳細をご覧ください。

x-page-title | x-displayName

ナビゲーションとページタイトルで使用されるタグの表示名を変更します。

openapi.yaml

openapi: '3.0'
info: ...
tags:
  - name: users
    x-page-title: Users

x-page-description

ページに説明を追加します。

openapi.yaml

openapi: '3.0'
info: ...
tags:
  - name: "users"
    x-page-title: "Users"
    x-page-description: "ユーザーアカウントとプロフィールを管理します。"

x-page-icon

ページに Font Awesome アイコンを追加します。利用可能なアイコンを参照してください を使って複数のクレームを条件エディタで組み合わせ、特定のユーザーに一致させることができます。演算子について詳しくは.

openapi.yaml

openapi: '3.0'
info: ...
tags:
  - name: "users"
    x-page-title: "Users"
    x-page-description: "ユーザーアカウントとプロフィールを管理します。"
    x-page-icon: "user"

parent | x-parent

GitBook でページを整理するために、タグに階層を追加します。

parent は OpenAPI 3.2+ における正式なプロパティ名です。OpenAPI 3.2 より前のバージョン（3.0.x、3.1.x）を使用している場合は、 x-parent の代わりに行うことをおすすめします。

openapi.yaml

openapi: '3.2'
info: ...
tags:
  - name: organization
  - name: admin
    parent: organization
  - name: user
    parent: organization    

x-hideTryItPanel

OpenAPI ブロックの「Test it」ボタンを表示または非表示にします。

openapi.yaml

openapi: '3.0'
info: ...
tags: [...]
paths:
  /example:
    get:
      summary: Example summary
      description: Example description
      operationId: examplePath
      responses: [...]
      parameters: [...]
      x-hideTryItPanel: true

x-expandAllResponses

各レスポンスを 1 つずつ表示するのではなく、すべてのレスポンスセクションを既定で展開します。

ルートに追加するとすべての操作に適用されます。操作に追加すると、そのエンドポイントのみに適用されます。

openapi.yaml

openapi: '3.0'
info: ...

# すべての操作のレスポンスを展開する
x-expandAllResponses: true

paths:
  /pets:
    get:
      summary: ペット一覧
      responses: [...]
      # 単一の操作では無効にする
      x-expandAllResponses: false

x-expandAllModelSections

ネストされたオブジェクトのプロパティを、ユーザー操作なしで表示できるように、すべてのモデル/スキーマセクションを既定で展開します。

ルートに追加するとすべての操作に適用されます。操作に追加すると、そのエンドポイントのみに適用されます。

openapi.yaml

openapi: '3.0'
info: ...

# すべての操作のモデルセクションを展開する
x-expandAllModelSections: true

paths:
  /pets:
    post:
      summary: ペットを作成
      requestBody: [...]
      responses: [...]
      # 単一の操作では無効にする
      x-expandAllModelSections: false

x-enable-proxy

GitBook の OpenAPI プロキシ経由で「Test it」リクエストを送信します。

ルートに追加するとすべての操作に適用されます。操作に追加すると、そのエンドポイントのみに適用されます。操作はルートの値を上書きします。

openapi.yaml

openapi: '3.0.3'
info: ...

# すべての操作でプロキシを有効にする
x-enable-proxy: true

paths:
  /health:
    get:
      summary: ヘルスチェック
      # 単一の操作では無効にする
      x-enable-proxy: false
      responses:
        '200':
          description: OK

詳しくは OpenAPI プロキシの使用.

x-codeSamples

OpenAPI ブロックのカスタムコードサンプルを表示、非表示、または含めます。

フィールド

フィールド名	入力します	説明
lang	string	コードサンプルの言語。値は次のいずれかである必要があります 一覧
ラベル	string	コードサンプルのラベル。例： Node または Python2.7, 任意, lang が既定で使用されます
source	string	コードサンプルのソースコード

openapi.yaml

openapi: '3.0'
info: ...
tags: [...]
paths:
  /example:
    get:
      summary: Example summary
      description: Example description
      operationId: examplePath
      responses: [...]
      parameters: [...]
      x-codeSamples:
        - lang: 'cURL'
          label: 'CLI'
          source: |
            curl -L \
            -H 'Authorization: Bearer <token>' \
            'https://api.gitbook.com/v1/user'

x-enumDescriptions

スキーマ内の各 enum 値ごとに個別の説明を追加します。

openapi.yaml

openapi: '3.0'
info: ...
components:
  schemas:
    project_status:
      type: string
      enum:
        - LIVE
        - PENDING
        - REJECTED
      x-enumDescriptions:
        LIVE: プロジェクトは公開されています。
        PENDING: プロジェクトは承認待ちです。
        REJECTED: プロジェクトは却下されました。

x-internal | x-gitbook-ignore

API リファレンスからエンドポイントを非表示にします。

openapi.yaml

openapi: '3.0'
info: ...
tags: [...]
paths:
  /example:
    get:
      summary: Example summary
      description: Example description
      operationId: examplePath
      responses: [...]
      parameters: [...]
      x-internal: true

x-stability

不安定または進行中のエンドポイントを示します。

サポートされる値： experimental, alpha, beta.

openapi.yaml

openapi: '3.0'
info: ...
tags: [...]
paths:
  /example:
    get:
      summary: Example summary
      description: Example description
      operationId: examplePath
      x-stability: experimental

deprecated

エンドポイントが非推奨かどうかを示します。非推奨のエンドポイントは、公開サイトで非推奨の警告を表示します。

openapi.yaml

openapi: '3.0'
info: ...
tags: [...]
paths:
  /example:
    get:
      summary: Example summary
      description: Example description
      operationId: examplePath
      responses: [...]
      parameters: [...]
      deprecated: true

x-deprecated-sunset

非推奨の操作に廃止日を追加します。

サポートされる値： ISO 8601 形式（YYYY-MM-DD）

openapi.yaml

openapi: '3.0'
info: ...
tags: [...]
paths:
  /example:
    get:
      summary: Example summary
      description: Example description
      operationId: examplePath
      responses: [...]
      parameters: [...]
      deprecated: true
      x-deprecated-sunset: 2030-12-05