3.1 OpenAPI 文档

一个自包含或复合资源，用于定义或描述 API 或 API 的元素。OpenAPI 文档必须至少包含一个paths字段、一个components字段或一个webhooks字段。OpenAPI 文档使用并符合 OpenAPI 规范。

3.2 路径模板

路径模板指的是使用由花括号({})分隔的模板表达式来标记 URL 路径的一部分，以便使用路径参数替换。

路径中的每个模板表达式必须对应于包含在Path Item本身和/或其每个Operation中的路径参数。如果路径项为空，例如由于 ACL 约束，则不需要匹配路径参数。

这些路径参数的值禁止包含[RFC3986] 第 3 节中描述的任何未转义的“通用语法”字符：正斜杠 (/)、问号 (?) 或井号 (#)。

3.3 媒体类型

媒体类型定义分散在多个资源中。媒体类型定义应该符合[RFC6838]。

一些可能的媒体类型定义示例

  text/plain; charset=utf-8
  application/json
  application/vnd.github+json
  application/vnd.github.v3+json
  application/vnd.github.v3.raw+json
  application/vnd.github.v3.text+json
  application/vnd.github.v3.html+json
  application/vnd.github.v3.full+json
  application/vnd.github.v3.diff
  application/vnd.github.v3.patch

3.4 HTTP 状态码

HTTP 状态码用于指示执行的操作的状态。可用状态码由[RFC7231] 第 6 节定义，注册的状态码列在IANA 状态码注册表中。