配置“测试它”按钮

你可以使用多个 OpenAPI 扩展在 GitBook 中配置“测试它”按钮及其配套窗口。这些扩展可以帮助改进并配置用户的测试套件。

隐藏“测试它”按钮

你可以通过添加 x-hideTryItPanel 到某个端点，或你的 OpenAPI 规范的根级别。

openapi.yaml

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

代理“测试它”请求

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

路由 “测试它” 通过在你的规范中添加 x-enable-proxy 到你的规范中。

参见使用 OpenAPI 代理中的示例。

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

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

声明你的认证方案

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

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

openapi: '3.0.3'
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

openapi: '3.0.3'
components:
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: 'https://auth.example.com/oauth/authorize'
          tokenUrl: 'https://auth.example.com/oauth/token'
          scopes:
            read:items: '读取项目'
            write:items: '写入项目'

在全局或按操作应用方案

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

paths:
  /reports:
    get:
      summary: 获取报告
      security:
        - apiKeyAuth: []
      responses:
        '200':
          description: 成功

使用以下内容控制端点 URL `servers`

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

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

servers:
  - url: https://api.example.com
    description: 生产环境
  - url: https://staging-api.example.com
    description: 预发布环境

servers:
  - url: https://{instance}.api.{region}.example.cloud
    variables:
      instance:
        default: acme
        description: 你的租户或实例 slug
      region:
        default: eu
        enum:
          - eu
          - us
          - ap
        description: 区域部署

paths:
  /reports:
    get:
      summary: 获取报告
      servers:
        - url: https://reports.api.example.com
      responses:
        '200':
          description: 成功

最后更新于 28天前

这有帮助吗？