术语定义

3.1 OpenAPI 文档

一（或多）份用来定义或描述一个 API 的文档。

3.2 Path 模板

Path 模板指用大括号标记来标记一段 URL 作为可替换的路径参数。

3.3 Media Types

媒体类型定义分散于多处。 媒体类型定义应当符合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 定义了有效的状态码，可以在 IANA Status Code Registry 找到已经被注册的状态码的列表。