DEV Community

adhanaAshu
adhanaAshu

Posted on

Swagger-as a documentation tool

Hi so this is my first post here on DEV. I've heard about Swagger so many times and everytime i want to use it, to contribute to Open source, i get so confused. Most of the blogs suggest how it is so great for lot of things development,testing,documentation and whatnot. i wish i can just explore swagger for say, one of it's feature maybe for writing api documentation. I get overwhelmed by the blogs that i get online and finally i just drop the idea . Please drop by and say hi,I would love to hear how other people learnt it or are learning it as self taught programmers.
Hi

Top comments (4)

Collapse
 
dagnelies profile image
Arnaud Dagnelies

Swagger usually refers to swagger 2. I recommend learning/using OpenAPI which supersedes it. It's definitely useful, but it's not the foundation. It's the extra sauce to document your web service API, and thereby also facilitating integrations and testing.

Collapse
 
ashkamrip profile image
adhanaAshu

I would take a look at OpenAPI thank you !

Collapse
 
biomathcode profile image
Pratik sharma

Don't learn Swagger. Try to build a rest api in python with fastapi or flask. You can then add Swagger in it for the documentation. It's more fun that way. Hi !!!!

Collapse
 
ashkamrip profile image
adhanaAshu

Thank you I would def try that approach !