「テスト」ボタンの設定

GitBook では、いくつかの OpenAPI 拡張を使用して、「Test It」ボタンとそれに付随するウィンドウを設定できます。これらの拡張は、ユーザー向けのテストスイートの改善と設定に役立ちます。

「Test it」ボタンを非表示にする

エンドポイントに 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

「Test it」リクエストをプロキシする

一部の API は、CORS が原因でブラウザからのリクエストをブロックします。

Route Test it のトラフィックを GitBook 経由でルーティングするには、 x-enable-proxy を仕様に追加します。

参照 OpenAPI proxy の使用 例をご覧ください。

テストウィンドウで認証を有効にする

リクエストランナーが認証を表示して適用できるのは、仕様でそれが宣言されている場合のみです。スキームを components.securitySchemesの下で定義し、次に security を使ってグローバルに、または操作ごとに（グローバル設定を上書き）紐付けます。

認証スキームを宣言する

以下は一般的なパターンです。YAML ではストレートクォートを使用してください。

HTTP Bearer（例: JWT）

openapi: '3.0.3'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

ヘッダー内の API キー

OAuth2（authorizationCode）

スキームをグローバルまたは操作ごとに適用する

グローバル

openapi: '3.0.3'
security:
  - bearerAuth: []
paths: ...

操作ごと

でエンドポイント URL を制御する servers

リクエストランナーは、 servers 配列で定義した URL をターゲットにします。1 つ以上のサーバーを宣言でき、変数でパラメータ化することもできます。

単一サーバー

openapi: '3.0.3'
servers:
  - url: https://instance.api.region.example.cloud

複数サーバー

サーバー変数

操作ごとのサーバー