OpenAPI

将 OpenAPI 规范添加到页面，并让用户在页面上使用交互式区块直接测试端点。

手动撰写 REST API 文档可能是一个耗时的过程。幸运的是，GitBook 通过允许您导入 OpenAPI 文档来简化此任务，这些文档详细描述了您的 API 的结构和功能。

OpenAPI 规范（OAS）是开发人员用于记录 REST API 的一个框架。它以 JSON 或 YAML 编写，概述了您所有的端点、参数、模式和身份验证方案。

一旦导入到 GitBook，这些文档会被转换为交互式且可测试的 API 模块，直观地表示您的 API 方法——无论规范是以文件形式提供还是从 URL 加载。

GitBook 支持 Swagger 2.0 或 OpenAPI 3.0 兼容的文件。

Add a new pet to the store.

post

Add a new pet to the store.

必需范围

此端点需要以下范围：

• : modify pets in your account
• : read your pets

授权

petstore_auth

OAuth2implicit必填

Authorization URL:

请求体

application/jsonapplication/xmlapplication/x-www-form-urlencoded

idinteger · int64可选Example: 10

namestring必填Example: doggie

photoUrlsstring[]必填

statusstring · enum可选

pet status in the store

可能的值:

响应

200

Successful operation

application/jsonapplication/xml

400

Invalid input

422

Validation exception

default

Unexpected error

post

/pet

HTTPcURLJavaScriptPython

POST /api/v3/pet HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "id": 10,
  "name": "doggie",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "text"
  ],
  "tags": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "status": "available"
}

application/jsonapplication/xmlapplication/x-www-form-urlencoded

{
  "id": 10,
  "name": "doggie",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "text"
  ],
  "tags": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "status": "available"
}

试用（由 Scalar 提供支持）

GitBook 的 OpenAPI 模块还支持“试用”功能，允许您的用户使用从编辑器填入的数据和参数来测试您的 API 方法。

由以下提供支持 Scalar，您无需离开文档即可查看您的 API 方法的实际运行。上方有一个示例。

常见问题

为什么我的规范无法加载？

注意： 此信息仅适用于 通过 URL 添加的规范.

如果您是通过 URL 添加规范，您的 API 必须 允许跨域 从您的文档站点进行 GET 请求。在您的 API 的 CORS 设置中，允许托管您文档的确切来源（例如， https://your-site.gitbook.io 或 https://docs.example.com）。 如果您的端点是公共的且不使用凭证，您也可以返回： Access-Control-Allow-Origin: *