配置“测试它”按钮

您可以在 GitBook 中使用多种 OpenAPI 扩展来配置“Test It”按钮及其配套窗口。这些扩展可以帮助改进并配置供用户使用的测试套件。

隐藏“Test it”按钮

您可以通过添加 x-hideTryItPanel 到某个端点，或到您的 OpenAPI 规范根级别，来隐藏端点中的“Test it”按钮。

openapi.yaml

openapi: '3.0'
info: ...
tags: [...]
paths:
  /example:
    get:
      summary: 示例摘要
      description: 示例描述
      operationId: examplePath
      responses: [...]
      parameters: [...]
      x-hideTryItPanel: true

代理“Test it”请求

一些 API 会阻止浏览器请求，通常是因为 CORS。

路由 Test it 流量通过 GitBook，只需添加 x-enable-proxy 到您的规范中。

参见 使用 OpenAPI 代理 示例。

在测试窗口中启用身份验证

如果您的规范声明了认证，请求运行器才能呈现并应用认证。在 components.securitySchemes下定义方案，然后通过 security 将其全局附加（适用于所有操作）或按操作附加（覆盖全局设置）。

声明您的认证方案

以下是常见模式。请在 YAML 中使用直引号。

HTTP Bearer（例如，JWT）

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

请求头中的 API Key

OAuth2（authorizationCode）

全局或按操作应用方案

全局

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

按操作

使用配置端点 URL servers

请求运行器会以您在 servers 数组中定义的 URL 为目标。请声明一个或多个服务器；您也可以使用变量对其进行参数化。

单个服务器

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

多个服务器

服务器变量

按操作设置服务器