Autogenerating Swagger Documentation with Node & Express

In this video we walk through creating a simple NodeJS/Express API endpoint and setting auto-generating documentation using Swagger. We can then test our API using the Swagger UI.
Code: github.com/brian-childress/no...

[@hastyarazad6179]

I have been searching around for almost 10 hours looking at different tutorials and articles. Nether one of them explained and demonstrated it like you. A verry BIG THANK YOUUU!!!. Keep up the good work

[@joaomatos1144]

2021: Simple and Direct approach, i like it =)

[@0ne4rif]

I find this video simple and straightforward, thank you!

[@dilmurodyangiboev1296]

That is what I need on my project. That is great tutorial thank you so much!

[@simopr09]

I have got to leave a comment at 6k views. This video will get soon A LOT of views!
Thank sir! You are a great instructor. Clear and concise.

[@Babe_Chinwendum]

115k views now. Your foresight>>>>>

[@ianlimasouza6896]

Thanks a lot for this, even the mistake with the put (customerS) at the end helped me understand it better haha great video!
NOTE: this also works without Docker for people who are unfamiliar to it (like me)

[@ganeshprasad6600]

excellant videos - very well explained about swagger, i don't know about swagger and finally learn from this video,

[@geetaghanti5934]

Very useful, just the information I needed.

[@GautamKumar-nn7bh]

This is great information. Thanks for sharing such wonderful information.

[@ananthpadmakar8240]

Thank you so much for a quick and easy tutorial. cool.

[@malayruparel9876]

Thanks for video. It helped to solve my issue. Well done!

[@damercadoo]

man this tutorial is Gold, thank you very much

[@ProtikPC_pro_indigo]

ruclips.net/video/FS0HmgzVcaI/видео.html
Watch this. A discussion and a high level overview of things.

[@EduardoMartins-lp7xy]

Nice tutorial, helped me a lot!! Thank you very much

[@karinepistili259]

Nice tutorial, helped me a lot! Thank you :)

[@min5187]

This is really useful. Thank you so much!!!!

[@darkomaksimovic3456]

Thanks buddy nodejs + express + swagger + docker + visual studio code + chrome + rest .... this video is like goldfish fulfilling desires.

[@HovhannesGasparyan-ex4el]

Thank you for the useful video!

[@floydfernandes2985]

Very Nicely explained.

[@prvinsharma]

a quick intro to swagger. thanks

[@mateuspedroso6547]

This was a great tutorial, thanks!!!!

[@PradeepVish1213]

Thanks for your explanation 😊😊

[@josealvarezcabrera561]

Amazing tutorial! Thanks.

[@benjose22]

Wonderful video. Thank you very much

[@ngneerin]

Very good job at the startup tutorial. Would appreciate if there is more in depth tutorial on swagger after this. Thanks.

[@Matisantillandev]

Great tutorial, it was very helpful. Thank you! I leave my like here

[@pnutstube]

Thank you very much for a good tutorial

[@TinyCoffe]

great tutorial! thank you very much :)

[@runyalen]

instructive video.. i would recomende to the author of these video to eat more vitamines, sport & better sleep !!

[@muhammadtarique242]

This really helped, Thank you

[@TheAmeer3881]

Very nice . Very clear.

[@wayne65]

Thank you. Helpful for me.

[@Kim-by5uy]

Really helpful, thanks

[@diegolopes1283]

Thank you, broo!

[@chanu1993]

God Video.. I love this. Works well

[@carloseduardoguedeslourenc4212]

Very cool, man!

[@raulalejandromunozaraya3878]

Awesome, thanks a lot!

[@madhavareddy580]

Useful. Thanks!

[@salahed-dineyoumir6605]

very usefull ~ thanks a lot !

[@leonardoars]

Many thanks!

[@annalopezribo1219]

This video was very instructive, thanks! But I decided to stick to the traditional way of documenting swagger routes. For me it looks more complicated this way, when autogenerating swagger routes it's tricky to have every mongoose schema as well in the docs, and the routes are not organized, also, visually it looks kinda messy to have all that written code for each endpoint in all my routes. I know that there are npm packages that help you with the schemas like "mongoose-to-swagger", but in the end it looks to me like an extra work and not like an automated process at all.

[@mariemmatri8743]

Thank you very much!

[@1N2345]

basically all i wanted to know ^^

[@cyberbyron]

Good tutorial :)

[@msimon4975]

Change the playback speed to 1.25
Thank me later.

[@jeremiahblessing3891]

Not all heroes wear caps

[@RockCYP]

More like playback speed: 2

[@TheAmeer3881]

Thank you

[@faller222]

right arrow key is my best friend

[@yassingourkani3856]

very useful thankful

[@mrcyber7073]

Than you very much !

[@jovemmestre3456]

god bless u bro :D

[@michaeljoshua8908]

Thanks a lot Bro

[@sagarkharade8535]

Thank you bro..!

[@ProtikPC_pro_indigo]

ruclips.net/video/FS0HmgzVcaI/видео.html
Watch this. A discussion and a high level overview of things.

[@nahbruhwhat]

Thanks!

[@ashwanigaur1828]

Thanks Man..

[@Hugo.Digital]

Thanks a lot

[@sachinbonde89]

Nice video

[@zakariachahboun]

thanks!

[@sharonhuaman2874]

Thank u

[@earthycoin]

Thanks

[@mdk124]

Is there anyway to generate some default documentation without writing the API Documentations (comments/openapi) manually? Like in ASP.NET core?

[@michalkotlicki4710]

Hey. Did you find out the answer to your question? If yes, can you tell me whether there is a way?

[@mdk124]

@@michalkotlicki4710 hey man, unfortunately I did not..

[@juliosantiesteban7709]

@@mdk124 a great way to auto generate api docs from comments is jsdoc, but dont know about something so sofisticated as swagger

[@rbltv]

top!

[@andreysholinka5057]

how to add authorize button in the top right corner?

[@nagavadlapudi]

_Issue I faced_
node_modules\swagger-jsdoc\index.js:1
import { prepare, extract, organize, finalize } from './src/specification.js';
Error: Unexpected token {
_Resolution that worked for me_
Following config on *package.json* worked
"devDependencies": {
"swagger-jsdoc": "6.0.0",
"swagger-ui-express": "^4.1.6"
}

[@madhavareddy580]

How to document Node Azure functions (serverless) using swagger or any other tool

[@tscheydee1482]

Any idea why the docker command doesnt work for me? It says invalid reference format.

[@harshverm776]

Can't we generate them direct?
I spring boot we just need to add swagger dependency and everything will be automatically come of the swagger page.

[@shanuruhela]

can you explain how to use header into swagger

[@volodymyrpliuta3916]

should those swagger packages go to devDependencies?

[@franzmg]

Hi Brian, I there one option for add swagger annotation to external file such as a router? thanks in advance

[@faller222]

no entendi lo que preguntaste pero en la variable SwaggerDeffinition viste que pone un valor en apis, el cual es un array.
Bueno ahi podes referenciar todos los Js que quieras, si vos tenes tu api en otro lado, podrias agragar ahi el archivo y asi incluirlo tambin,
De hecho en mi caso, pongo la definicion de los schemas en cada clase, y las rutas en el router, y queda todo junto a lfinal, lo unico que hay que hacer usar los #ref que podes ver en la doc de swagger

[@bilkisuismail6096]

And what happened to this great instructor, no more videos from him

[@Siddharth-yi7pg]

how to add params in docs?

[@pushkardeshmukh1987]

can you please show how to write code for post when i want to pass parameter to the API

[@deepeshjha7838]

Hi Pushkar, did you get a solution? please respond

[@yadavkishan3778]

npm i install swagger-jsdoc swagger-ui-express

[@Bitrey]

thanks

[@whatthefunction9140]

Hi Bryan 👋

[@juanjoseordonez8669]

How can i define the parameters?

[@ThinKingKaraoke]

how to use with jwt sir ?

[@marcella3030]

My comments about API didn't appear on the generated page, and it doesn't show any error

[@Marlonbrito]

you can resolve?

[@arielalejandrowagner1593]

I have same problem!

[@gustavotorresrodriguez2483]

I have the same issue

[@cruelplatypus67]

same

[@Cheezincharlie]

You have to make sure that the "apis" property of the "swaggerDefinition" object is correct for wherever your comments are. (app.js in the video mine is ./server.js for absolute location. )

[@luisgabrielmxm]

Hi bro, I'm using MVC architecture and I'm having trouble configuring, swagger can't find the routes to generate the documentation, could you save me?

[@NickChlam]

point to the folder where your routes are - apis: ['./routes/*.js'],

[@luisgabrielmxm]

@@NickChlam thx bro,

[@franzmg]

@@NickChlam it doesn't work for me, could somebody help me please?

[@raulterraferrao696]

If do not appear anything, don't forget the '/' before the name of the route.

[@souravpanda8814]

Hi. It's a wonderul video. But, when I am installing js-doc why it's showing error. Unexpected token u at node_modules/swagger-jsdcoc/lib/index.js

[@gabrielfelipenunezjuarez3492]

i had the same error, in my case that was for wrote wrong *swaggerDefinitions* instead of *swaggerDefinition*

[@GeejayBathan]

how to add authentication token in swagger?

[@ProtikPC_pro_indigo]

ruclips.net/video/FS0HmgzVcaI/видео.html
Watch this. A discussion and a high level overview of things.

[@sakshibargal4540]

What is documentation?

[@yjg30737]

This is more like copy and paste and change slightly.

[@bonus22]

Your tutorial is very good, but it's definitely is not a auto generated Swagger

[@shapedthought]

Good tutorial but get a better mic!

[@jeckefe]

THIS IS NOT AUTO. BYE

[@uadev9913]

This not Autogenerating! All routs, object you must write!

[@geekybench]

3 minutes in and still haven't touched swagger. Dude we don't need to know why we need to document our code, we don't need to learn how to initialise a new npm project, we don't need to know how to create a new express API. Just show us what you've stated in the title. Autogenerating swagger documentation using an express api. This video could have been 5 minutes long.

[@Alex-vi6fr]

you can skip some part, it's not that hard

[@Tyuvfdhb]

Thanks for the tutorial. I was unable to use swagger-jsdoc@7x (node14x) since it requires import instead of "require". The easiest solution was to use swagger-jsdoc@6x

[@rubenfernandezsantos5048]

In theory, imports can be used with swagger-jsdoc 7. I checked the documentation the documentation here www.npmjs.com/package/swagger-jsdoc and now it's necessary to use "await" when we passed the options to swaggerJsdoc as follows:

[@rubenfernandezsantos5048]

const openapiSpecification = await swaggerJsdoc(options);