And that schema includes definitions (or "schemas") of the data sent and received by your API using JSON Schema, the standard for JSON data schemas. OpenAPI defines an API schema for your API. In that case, it would mean the JSON attributes, and data types they have, etc. The term "schema" might also refer to the shape of some data, like a JSON content. This schema definition includes your API paths, the possible parameters they take, etc. In this case, OpenAPI is a specification that dictates how to define a schema of your API. Not the code that implements it, but just an abstract description. ![]() "Schema" ¶Ī "schema" is a definition or description of something. You will see the alternative automatic documentation (provided by ReDoc):įastAPI generates a "schema" with all your API using the OpenAPI standard for defining APIs. ![]() ![]() You will see the automatic interactive API documentation (provided by Swagger UI): OAuth2 with Password (and hashing), Bearer with JWT tokensĬustom Response - HTML, Stream, File, othersĪlternatives, Inspiration and Comparisons Step 4: define the path operation functionĭependencies in path operation decorators
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |