Browse Source

docs: clarify OpenAPI explanation

Adds a small clarification to make the OpenAPI explanation easier to understand for beginners.
pull/14638/head
Yaswanth Naga Sai K 7 months ago
committed by GitHub
parent
commit
7a596734d1
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
  1. 3
      docs/en/docs/tutorial/first-steps.md

3
docs/en/docs/tutorial/first-steps.md

@ -83,8 +83,7 @@ You will see the alternative automatic documentation (provided by <a href="https
![ReDoc](https://fastapi.tiangolo.com/img/index/index-02-redoc-simple.png) ![ReDoc](https://fastapi.tiangolo.com/img/index/index-02-redoc-simple.png)
### OpenAPI { #openapi } ### OpenAPI { #openapi }
FastAPI generates a "schema" with all your API using the OpenAPI standard for defining APIs. In simple terms, this is a structured description of your API that tools can read to show documentation and understand how your endpoints work.
**FastAPI** generates a "schema" with all your API using the **OpenAPI** standard for defining APIs.
#### "Schema" { #schema } #### "Schema" { #schema }

Loading…
Cancel
Save