拡張機能リファレンス

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

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

GitBook では、OpenAPI spec に追加できるさまざまな拡張機能を通じて、公開サイト上での 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 ブロックの「テストする」ボタンを表示または非表示にします。

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: [...]
      # 1 つの操作だけを対象外にする
      x-expandAllResponses: false

x-expandAllModelSections

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

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

openapi.yaml

openapi: '3.0'
info: ...

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

paths:
  /pets:
    post:
      summary: ペットを作成する
      requestBody: [...]
      responses: [...]
      # 1 つの操作だけを対象外にする
      x-expandAllModelSections: false

x-enable-proxy

「テストする」リクエストを GitBook の OpenAPI プロキシ経由でルーティングします。

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

openapi.yaml

openapi: '3.0.3'
info: ...

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

paths:
  /health:
    get:
      summary: ヘルスチェック
      # 1 つの操作だけを対象外にする
      x-enable-proxy: false
      responses:
        '200':
          description: OK

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

x-codeSamples

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

Fields

Field Name	Type	Description
lang	string	コードサンプルの言語。値は次のいずれかである必要があります list
label	string	コードサンプルのラベル。たとえば Node または Python2.7, optional, 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