Skip to content

Commit f6be410

Browse files
authored
Update README.md
1 parent 22277e4 commit f6be410

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,20 @@
33
The Settle APIs formalized in an OpenAPI Description document.
44

55
Machine-readable API descriptions are ubiquitous nowadays and [OpenAPI](https://www.openapis.org/) is **the most broadly adopted industry standard for describing new APIs**.
6+
7+
## Advantages of Using OpenAPI
8+
9+
Having your API formally described in a machine-readable format allows automated tools to process it, instantly opening the door to:
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.
13+
- **Documentation Generation**: Create traditional human-readable documentation based on the machine-readable description, which always stays up-to-date.
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+
- **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.
17+
- **Security Analysis**: Discover possible vulnerabilities at the API design stage instead of much, much later.
18+
19+
On top of this, the OpenAPI Specification also provides you with:
20+
- **A non-proprietary format**: You have a say in the future direction of the Specification!
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+
- **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)