參考：

1. OpenAPI3.0 規(guī)范：OpenAPI 3.0規(guī)范

RFC說(shuō)明

媒體類(lèi)型：RFC6838? ?樣例：content-type:application/json; charset=utf-8

HTTP狀態(tài)碼:RFC7231??IANA Status Code Registry?可以查詢(xún)到所有狀態(tài)碼，樣例：Status Code:

200

URL的相對(duì)引用：除非明確指定，所有 URL 類(lèi)型的屬性值都可以是相對(duì)地址，就如 RFC3986 中定義的那樣以 Server Object 作為 Base URI。

總結(jié)

規(guī)范包含版本、格式、文檔結(jié)構(gòu)、數(shù)據(jù)類(lèi)型

版本

遵循語(yǔ)義化版本2.0.0?任何兼容開(kāi)放API規(guī)范 3.*.* 的文檔應(yīng)當(dāng)包含一個(gè)openapi 字段用來(lái)表明它使用的規(guī)范的語(yǔ)義化版本。

格式

1.遵從OPENAPI規(guī)范的文檔是一個(gè)自包含JSON對(duì)象，可以使用JSON和YMAL格式編寫(xiě)

2.規(guī)范內(nèi)的所有字段名都是小寫(xiě)。

3.推薦使用1.2版本的YAML格式，而且還需要符合以下限制：

Tags 必須被限制在JSON Schema允許的范圍內(nèi)。

Keys 必須是YAML schema規(guī)范定義的純字符串。

文檔結(jié)構(gòu)

？

數(shù)據(jù)類(lèi)型

富文本格式？

URL的相對(duì)引用

縮略語(yǔ)

?URI: Uniform Resource Identifier (URI) RFC3986定義說(shuō)明

URL:Uniform Resource Locator??The term "Uniform Resource Locator" (URL) refers to the subset of URIs? ? that, in addition to identifying a resource, provide a means of? locating the resource by describing its primary access mechanism? ?(e.g., its network "location").

URN:Uniform Resource Name?The term "Uniform Resource Name" (URN) has been used historically to refer to both URIs under the "urn" scheme [RFC2141], which are required to remain globally unique and persistent even when the resource ceases to exist or becomes unavailable, and to any other URI with the properties of a name.

URI樣例：