|
1 | | -# The OpenAPI Specification (fka The Swagger Specification) |
| 1 | +# The OpenAPI Specification |
2 | 2 |
|
3 | 3 | [](https://travis-ci.org/OAI/OpenAPI-Specification) |
4 | 4 |
|
5 | 5 |  |
6 | 6 |
|
7 | | -**The OAS 3.0.0-RC0 Spec can be [found here](https://github.com/OAI/OpenAPI-Specification/blob/3.0.0-rc0/versions/3.0.md)** |
| 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 goal of The OpenAPI Specification is to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, 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 interfaces have done for lower-level programming, OpenAPI 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 include interactive documentation, code generation for documentation, client, and server, as well as automated test cases. OpenAPI-enabled APIs expose JSON files that correctly adhere to the OpenAPI Specification, documented in this repository. These files 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 | | -Without going into a long history of interfaces to Web Services, this is not the first attempt to do so. We can learn from CORBA, WSDL and WADL. These specifications had good intentions but were limited by proprietary vendor-specific implementations, being bound to a specific programming language, and goals which were too open-ended. In the end, they failed to gain traction. |
14 | | - |
15 | | -OpenAPI 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-ful API. OpenAPI 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. |
16 | 14 |
|
17 | 15 | This GitHub project is the starting point for OpenAPI. |
18 | | -Here you will find the information you need about the OpenAPI Specification, a simple static sample of what it looks like, |
19 | | -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. |
20 | 17 |
|
| 18 | +## Current Version - 3.0 |
21 | 19 |
|
22 | | -## Current Version - 2.0 |
| 20 | +The current version of the OpenAPI specification is [OpenAPI Specification 3.0](versions/3.0.0.md). |
23 | 21 |
|
24 | | -The current version of the OpenAPI specification is 2.0 - and you can find it [here](versions/2.0.md). |
| 22 | +### Future Versions |
25 | 23 |
|
26 | | -### [OpenAPI 2.0 Specification](versions/2.0.md) |
| 24 | +[3.0.1](https://github.com/OAI/OpenAPI-Specification/tree/v3.0.1) - The next PATCH version. Patch-level fixes (typos, clarifications, etc.) should be submitted against this branch. |
27 | 25 |
|
28 | | -This repository contains the existing Swagger 1.2, 2.0 specifications as well as proposals for the next version of the specification, which will be called the OpenAPI Specification 3.0. The proposals live in the [OpenAPI.next](https://github.com/OAI/OpenAPI-Specification/tree/OpenAPI.next) branch. |
| 26 | +### Previous Versions |
29 | 27 |
|
30 | | -## Structure |
| 28 | +This repository also contains the [OpenAPI Specification 2.0](versions/2.0.md), which is identical to the Swagger 2.0 specification before it was renamed to “OpenAPI Specification”, |
| 29 | +as well as the Swagger 1.2 and Swagger 2.0 specifications. |
31 | 30 |
|
32 | | -Each section should contain v1.2 and v2.0 folders to avoid confusion between the versions. |
| 31 | +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. |
33 | 32 |
|
34 | | -Please keep in mind that the other projects under OpenAPI use an independent version system. |
35 | | -As such, don't confuse the version of the OpenAPI Specification they support and the version of that given library. |
| 33 | +## See It in Action |
36 | 34 |
|
37 | | -## The Wiki |
| 35 | +If you just want to see it work, check out the [list of current examples](examples/v3.0). |
38 | 36 |
|
39 | | -Check out the [wiki](https://github.com/OAI/OpenAPI-Specification/wiki) for additional and relevant information about the project. |
| 37 | +## Tools and Libraries |
40 | 38 |
|
41 | | -This includes: |
42 | | -- Static sample tutorial. |
43 | | -- List of known deployments. |
44 | | -- Revision history. |
| 39 | +Looking to see how you can create your own OpenAPI definition, present it, or otherwise use it? Check out the growing |
| 40 | +[list of 3.0 Implementations](IMPLEMENTATIONS.md). |
45 | 41 |
|
46 | | -## See it in Action |
| 42 | +## Participation |
47 | 43 |
|
48 | | -If you just want to see it work, check out the [pet store sample](http://petstore.swagger.io/). |
| 44 | +The current process for development of the OpenAPI Specification is described in |
| 45 | +[Development Guidelines](DEVELOPMENT.md). |
| 46 | +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). 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. |
49 | 47 |
|
50 | | -## Tools and Libraries |
| 48 | +The Open API Initiative encourages participation from individuals and companies alike. |
| 49 | +If you want to participate in the evolution of the OpenAPI Specification, consider taking the following actions: |
51 | 50 |
|
52 | | -Looking to see how you can create your own OpenAPI definition, present it or otherwise use it? Check out our [list of tools](http://swagger.io/open-source-integrations/) over at [http://swagger.io](http://swagger.io/open-source-integrations/). |
| 51 | +* Review the [current specification](versions/3.0.0.md). The human-readable markdown file _is the source of truth_ for the specification. |
| 52 | +* Review the [development](DEVELOPMENT.md) process so you understand how the spec is evolving. |
| 53 | +* Check the [issues](https://github.com/OAI/OpenAPI-Specification/issues) and [pull requests](https://github.com/OAI/OpenAPI-Specification/pulls) to see if someone has already documented your idea or feedback on the specification. You can follow an existing conversation by adding a comment to the existing issue or PR. |
| 54 | +* Create an issue to describe a new concern. If possible, propose a solution. |
53 | 55 |
|
54 | | -(Yes, there used to be a really long list here, we just moved it to the main website) |
| 56 | +Not all feedback can be accommodated and there may be solid arguments for or against a change being appropriate for the specification. |
55 | 57 |
|
56 | 58 | ## License |
57 | 59 |
|
58 | | -Copyright 2016 The Linux Foundation |
59 | 60 |
|
60 | | -Licensed under the Apache License, Version 2.0 (the "License"); |
61 | | -you may not use this file except in compliance with the License. |
62 | | -You may obtain a copy of the License at [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0) |
| 61 | +See: [License (Apache-2.0)](https://github.com/OAI/OpenAPI-Specification/blob/master/LICENSE) |
| 62 | + |
63 | 63 |
|
64 | | -Unless required by applicable law or agreed to in writing, software |
65 | | -distributed under the License is distributed on an "AS IS" BASIS, |
66 | | -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
67 | | -See the License for the specific language governing permissions and |
68 | | -limitations under the License. |
| 64 | + |
0 commit comments