Skip to content

Commit efc90bc

Browse files
authored
Merge pull request #71 from davidleger95/fix/broken-link
fix: update broken link (fixes #70)
2 parents 618b67c + 42dc8fa commit efc90bc

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

introduction.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,9 @@ title: Introduction
44
nav_order: 2
55
---
66

7-
87
# Introduction
98

10-
The **OpenAPI Specification** (**OAS**) allows the description of a remote API accessible through HTTP or HTTP-like protocols. This description, which may be stored as one or more documents (such as local files or HTTP-accessible network resources), is called an **OpenAPI Description** (**OAD**). This chapter explains why describing your API with an OAD is a good thing, and why it might interest you.
9+
The **OpenAPI Specification** (**OAS**) allows the description of a remote API accessible through HTTP or HTTP-like protocols. This description, which may be stored as one or more documents (such as local files or HTTP-accessible network resources), is called an **OpenAPI Description** (**OAD**). This chapter explains why describing your API with an OAD is a good thing, and why it might interest you.
1110

1211
The concept of an "API" is described first and the advantages of describing APIs using a machine-readable format are introduced, followed by the benefits of using the OAS format. In the last section, the evolution of API descriptions is put into perspective with a brief historical summary.
1312

@@ -54,7 +53,7 @@ The next section shows how some of these problems can be alleviated by specifyin
5453

5554
An **API description file** (sometimes called _contract_) is a **machine-readable** specification of an API. It should strive to be as **complete**, and **fully-detailed** as possible, although absolute completeness is not usually a requirement. Also, just like legal contracts, the more **unambiguous** it is, the more useful it becomes.
5655

57-
Its main advantage over documentation which only humans can read is that it enables **automated processing**, opening the door to the benefits listed at [the beginning of this guide](start-here).
56+
Its main advantage over documentation which only humans can read is that it enables **automated processing**, opening the door to the benefits listed at [the beginning of this guide](/#advantages-of-using-openapi).
5857

5958
To begin with, documentation for humans including the list of available methods and their details can be easily generated from the API description file. Done as a step in the build process, this easily prevents out-of-sync docs.
6059

0 commit comments

Comments
 (0)