Swagger API documentation tutorial for beginners - 4 - Open API specification summary

preview_player
Показать описание
Swagger allows you to describe the structure of your APIs so that machines can read them.

The ability of APIs to describe their own structure is the root of all awesomeness in Swagger. Why is it so great? Well, by reading your API’s structure, we can automatically build beautiful and interactive API documentation. We can also automatically generate client libraries for your API in many languages and explore other possibilities like automated testing.

Swagger does this by asking your API to return a YAML or JSON that contains a detailed description of your entire API. This file is essentially a resource listing of your API which adheres to OpenAPI Specification. The specification asks you to include information like:

What are all the operations that your API supports?
What are your API’s parameters and what does it return?
Does your API need some authorization?
And even fun things like terms, contact information and license to use the API.
Рекомендации по теме
Комментарии
Автор

Create Tutorial, you explained everything so clearly and straight to the point thanks

MartinPhalane
Автор

Very well composed and presented. Thank You.

TT-itic
Автор

Thank you. Is it possible to auto generate the documentation from the code? Something like Javadocs or jsdocs?

khalidelgazzar
Автор

Literally all the new junior programmers: 3:40

poutnik
Автор

Hi, thanks for the tutorial, can you please share a tutorial about the structure about PUT request? if i need to update some data on Xml response Values

yvonandrianirina
Автор

Nice video anyway, but i have a question. Is it possible to design api docs without existing api at localhost?

bowglad
Автор

Hey @Braintemple Tutorial TV,
Is there a way to auto-generate swagger documentation?

gale
Автор

I have an error when i press execute in the web. it shows me "😱 Could not render this component, see the console." (with the emoji include). The url is ok and it send me information when i pass in the local server. I don't know why it shows me that.

diegotorres
Автор

Good morning excuse me, I have an error with the "Code" Section, the details say "TypeError: Failed to fetch" Can you help me? Thank you!

chuy