「テストする」ボタンの設定

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

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

エンドポイントに次のものを追加することで、エンドポイントから「Test it」ボタンを非表示にできます。 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

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

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

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

参照 OpenAPI プロキシの使用 例についてはこちら。

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

リクエストランナーは、spec に認証が宣言されている場合にのみ、それを表示して適用できます。認証スキームを 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

リクエストランナーは、次の中で定義した URL に対して処理を行います。 servers 配列。1つ以上の server を定義できます。変数を使ってパラメータ化することもできます。

単一の server

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

複数の server

server 変数

オペレーションごとの server