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
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,17 +6,17 @@ Machine-readable API descriptions are ubiquitous nowadays and [OpenAPI](https://
6
6
7
7
## Advantages of Using OpenAPI
8
8
9
-
Having your API formally described in a machine-readable format allows automated tools to process it, instantly opening the door to:
9
+
Having our APIs formally described in a machine-readable format allows automated tools to process it, instantly opening the door to:
10
10
11
-
-**Description Validation and Linting**: Check that your description file is syntactically correct and adheres to a specific version of the Specification and the rest of your team’s formatting guidelines.
12
-
-**Data Validation**: Check that the data flowing through your API (in both directions) is correct, during development and once deployed.
11
+
-**Description Validation and Linting**: Check that the description file is syntactically correct and adheres to a specific version of the Specification and the rest of our teams formatting guidelines.
12
+
-**Data Validation**: Check that the data flowing through our APIs (in both directions) is correct, during development and once deployed.
13
13
-**Documentation Generation**: Create traditional human-readable documentation based on the machine-readable description, which always stays up-to-date.
14
14
-**Code Generation**: Create both server and client code in any programming language, freeing developers from having to perform data validation or write SDK glue code, for example.
15
15
-**Graphical Editors**: Allow easy creation of description files using a GUI instead of typing them by hand.
16
-
-**Mock Servers**: Create fake servers providing example responses which you and your customers can start testing with before you write a single line of code.
16
+
-**Mock Servers**: Create fake servers providing example responses which we and our third-party developers can start testing with before single line of code is written.
17
17
-**Security Analysis**: Discover possible vulnerabilities at the API design stage instead of much, much later.
18
18
19
-
On top of this, the OpenAPI Specification also provides you with:
19
+
On top of this, the OpenAPI Specification also provides us with:
20
20
-**A non-proprietary format**: You have a say in the future direction of the Specification!
21
21
-**The most developed tooling ecosystem**: As a direct result of the previous statement, OpenAPI offers a vast number of tools to work with it. Just take a quick look at [OpenAPI.Tools](https://openapi.tools/).
22
22
-**A format readable by both machines and humans**: Even though writing OpenAPI documents by hand is not the most convenient way of doing it *(See [Best Practices](https://oai.github.io/Documentation/best-practices.html))*, they are plain text files which can be easily browsed in case something needs to be debugged.
0 commit comments