Skip to content

Commit 8840eb2

Browse files
authored
Update README.md
1 parent f6be410 commit 8840eb2

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@ Machine-readable API descriptions are ubiquitous nowadays and [OpenAPI](https://
66

77
## Advantages of Using OpenAPI
88

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:
1010

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.
1313
- **Documentation Generation**: Create traditional human-readable documentation based on the machine-readable description, which always stays up-to-date.
1414
- **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.
1515
- **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.
1717
- **Security Analysis**: Discover possible vulnerabilities at the API design stage instead of much, much later.
1818

19-
On top of this, the OpenAPI Specification also provides you with:
19+
On top of this, the OpenAPI Specification also provides us with:
2020
- **A non-proprietary format**: You have a say in the future direction of the Specification!
2121
- **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/).
2222
- **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

Comments
 (0)