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.

授权

petstore_auth

请求体

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

HTTPcURLJavaScriptPython

POST /api/v3/pet HTTP/1.1
Host: 
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 方法的实际运行情况。上方有一个示例。