You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-17Lines changed: 10 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -6,28 +6,27 @@
6
6
7
7
The OpenAPI Specification is a community driven, open specification within the [Open API Initiative](https://www.openapis.org/), a Linux Foundation Collaborative Project.
8
8
9
-
The OpenAPI Specification defines a standard, language-agnostic interface description for REST APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, additional documentation, or through network traffic inspection. When properly defined via OpenAPI, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interface descriptions have done for lower-level programming, the OpenAPI Specification removes the guesswork in calling the service.
9
+
The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for REST APIs, which allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, additional documentation, or inspection of network traffic. When properly defined via OpenAPI, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interface descriptions have done for lower-level programming, the OpenAPI Specification removes guesswork in calling a service.
10
10
11
-
Use cases for machine-readable API interfaces includeinteractive documentation; code generation for documentation, client, and server; and automated test cases. OpenAPI descriptions describe APIs via YAML or JSON documents that adhere to the OpenAPI Specification. These documents can either be produced and served statically, or be generated dynamically from your application.
11
+
Use cases for machine-readable API definition documents include, but are not limited to, interactive documentation; code generation for documentation, clients, and servers; and automation of test cases. OpenAPI documents describe an API's services and are represented in either YAML or JSON formats. These documents may either be produced and served statically or be generated dynamically from an application.
12
12
13
-
The OpenAPI Specification does not require you to rewrite your existing API. It does not require binding any software to a service--the service being described may not even be yours. It does, however, require the capabilities of the service be described in the structure of the OpenAPI Specification. Not all services can be described by OpenAPI--this specification is not intended to cover every possible use-case of a REST API. The OpenAPI Specification does not define a specific development process such as design-first or code-first. It does facilitate either technique by establishing clear interactions with a REST API.
13
+
The OpenAPI Specification does not require rewriting existing APIs. It does not require binding any software to a service—the service being described may not even be owned by the creator of its description. It does, however, require the capabilities of the service be described in the structure of the OpenAPI Specification. Not all services can be described by OpenAPI—this specification is not intended to cover every possible style of REST APIs. The OpenAPI Specification does not mandate a specific development process such as design-first or code-first. It does facilitate either technique by establishing clear interactions with a REST API.
14
14
15
15
This GitHub project is the starting point for OpenAPI.
16
-
Here you will find the information you need about the OpenAPI Specification, simple examples of what it looks like,
17
-
and some general information regarding the project.
16
+
Here you will find the information you need about the OpenAPI Specification, simple examples of what it looks like, and some general information regarding the project.
18
17
19
18
## Current Version - 3.0
20
19
21
20
The current version of the OpenAPI specification is [OpenAPI Specification 3.0](versions/3.0.md).
22
21
23
22
### Previous Versions
24
23
25
-
This repository also contains the [OpenAPI Specification 2.0](versions/2.0), which is identical to the Swagger 2.0 specification,
24
+
This repository also contains the [OpenAPI Specification 2.0](versions/2.0), which is identical to the Swagger 2.0 specification before it was renamed to “OpenAPI Specification”,
26
25
as well as the Swagger 1.2 and Swagger 2.0 specifications.
27
26
28
27
Each folder in this repository, such as [examples](examples) and [schemas](schemas), should contain folders pertaining to the current and previous versions of the specification.
29
28
30
-
## See it in Action
29
+
## See It in Action
31
30
32
31
If you just want to see it work, check out the [list of current examples](examples/v3.0).
33
32
@@ -40,7 +39,7 @@ Looking to see how you can create your own OpenAPI definition, present it or oth
40
39
41
40
The current process for development of the OpenAPI Specification is described in
42
41
[Development Guidelines](DEVELOPMENT.md).
43
-
Development of the next version of the OpenAPI Specification is guided by the [Technical Developer Community](https://www.openapis.org/participate/how-to-contribute/governance#TDC) and governed by the [TDC Contributors](CONTRIBUTORS.md). This group of committers bring their API expertise, incorporate feedback from the community, and expand the group of committers as appropriate. All development activity on the future specification will be performed as features and merged into this branch. Upon release of the future specification, this branch will be merged to master.
42
+
Development of the next version of the OpenAPI Specification is guided by the [Technical Developer Community](https://www.openapis.org/participate/how-to-contribute/governance#TDC) and governed by the [TDC Contributors](CONTRIBUTORS.md). This group of committers bring their API expertise, incorporate feedback from the community, and expand the group of committers as appropriate. All development activity on the future specification will be performed as features and merged into this branch. Upon release of the future specification, this branch will be merged to master.
44
43
45
44
The Open API Initiative encourages participation from individuals and companies alike.
46
45
If you want to participate in the evolution of the OpenAPI Specification, consider taking the following actions:
@@ -54,14 +53,8 @@ Not all feedback can be accommodated and there may be solid arguments for or aga
54
53
55
54
## License
56
55
57
-
Copyright 2016, 2017 The Linux Foundation
58
56
59
-
Licensed under the Apache License, Version 2.0 (the "License");
60
-
you may not use this file except in compliance with the License.
61
-
You may obtain a copy of the License at [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
0 commit comments