拡張機能リファレンス

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-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 proxy の使用.

x-codeSamples

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

フィールド

フィールド名	入力	説明
lang	string	コードサンプルの言語。値は次のいずれかである必要があります リスト
label	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