OpenAPI3.0学习总结

参考:

1. OpenAPI3.0 规范:OpenAPI 3.0规范

RFC说明

媒体类型:RFC6838   样例:content-type:application/json; charset=utf-8

HTTP状态码:RFC7231  IANA Status Code Registry 可以查询到所有状态码,样例:Status Code:

200

URL的相对引用:除非明确指定,所有 URL 类型的属性值都可以是相对地址,就如 RFC3986 中定义的那样以 Server Object 作为 Base URI。

总结

规范包含版本、格式、文档结构、数据类型

版本

遵循语义化版本2.0.0 任何兼容开放API规范 3.*.* 的文档应当包含一个openapi 字段用来表明它使用的规范的语义化版本。

格式

1.遵从OPENAPI规范的文档是一个自包含JSON对象,可以使用JSON和YMAL格式编写

2.规范内的所有字段名都是小写

3.推荐使用1.2版本的YAML格式,而且还需要符合以下限制:

Tags 必须被限制在JSON Schema允许的范围内。

Keys 必须是YAML schema规范定义的纯字符串。

文档结构

数据类型



富文本格式?


URL的相对引用



缩略语

 URI: Uniform Resource Identifier (URI) RFC3986定义说明

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样例:




©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容