Spring boot 3 - OpenApi Documentation | Swagger UI

#SpringBoot3 #OpenAPI3 #SwaggerUI #RESTAPI #JWTSecurity
In this comprehensive video tutorial, we will explore how to seamlessly integrate OpenAPI 3 and Swagger UI with a Spring Boot 3 application to document a REST API. Moreover, we'll demonstrate how to add JWT (JSON Web Token) security support for the API documentation, ensuring a secure and robust API.
🎁 Spring Data JPA course: aliboucoding.com/p/the-full-g...
🎁 🚀 COUPON Code: EARLYBIRD20
Don't Forget to
===========================================
💯 Free courses here: aliboucoding.com/courses
💯 Subscribe to the youtube channel
💯 Join our Discord Community - / discord
💯 Join our Facebook Group - / 589612651142975
💯 Join our Instagram: / alibou_coding
Throughout this tutorial, you will learn:
00:00 Intro
01:24 Walking through the official documentation
03:57 Add the OpenApi dependency
06:44 Whitelist the Swagger resources
08:15 Walk through the Swagger UI interface
12:32 Add OpenApi configuration (annotations)
19:32 Add security scheme
23:25 Add security requirements
27:26 Customise endpoints
32:15 Hide endpoints
34:33 Outro
By the end of this tutorial, you'll have a solid understanding of how to use OpenAPI 3 and Swagger UI to create well-documented and secure REST APIs. This knowledge will help you build more professional and user-friendly APIs, boosting the overall quality and maintainability of your projects.
Don't forget to like, comment, and subscribe for more tutorials on Spring Boot, OpenAPI, and other web development topics. If you have any questions or suggestions, feel free to leave a comment below.

[@BoualiAli]

Join the Micro Services course waiting list and get and get an exclusive *EARLY-BIRD discount* aliboucoding.ck.page/d0f9317e13

[@ayyubxonrustamov700]

This is a great swagger tutorial! I loved it! Thank you Alibou for the awesome content!

[@BoualiAli]

Really happy you liked it

[@tanaykamath1415]

One of the few creators who posts videos on Spring Boot, thanks a lot!!

[@BoualiAli]

Happy you liked it!

[@niccubagonoc9907]

Such a goldmine channel! So glad I stumbled to your channel! Keep the knowledge flowing brother!

[@BoualiAli]

My pleasure! Happy to have you within the family

[@abu-dukhan]

Wollah to me you are the best content creator in the entire KZbin Ali 🥰 Thank you so so much Alibou. May Allah reward you abundantly.

[@BoualiAli]

this comment really made my day. I will never stop creating content especially for nice people like you. God bless you

[@federicovinas1486]

Thanks a lot! I've seen a lot of tutorials and yours is the best ! Everything worked at the first attempt

[@BoualiAli]

My pleasure!

[@llummin]

Thank you for the best Spring Security content at the moment! Please continue to delight us with new videos! I would like to see something about JUnit. 🥺

[@BoualiAli]

Thank you for the nice feedback. I will prepare a video for Unit testing (soon)

[@IzharJumadi]

Alhamdulillah, been waiting for this

[@BoualiAli]

Always happy to help

[@oumaimabenjouida6724]

That was so useful, and u have an amazing way of explaining things, thank you!

[@BoualiAli]

Glad it was helpful!

[@fearlessflow3308]

Your videos are amazing and very very easy to understand, regardless if the topic is complex or not. What would I like to see is a tutorial for INTEGRATION tests, but not the integration tests of controllers which are methods that add two numbers but something more complex. Keep up the great work and thanks for all you do!

[@BoualiAli]

Great suggestion! What about integration tests with postman collections and newman to run them independently?

[@fearlessflow3308]

@@BoualiAli I think that would be great as a follow up, to the topic i suggested in the first place. Make a series of it or something maybe 😁 Thanks for the reply!

[@BoualiAli]

@@fearlessflow3308 i will make a serie for testing covering all test phases

[@fearlessflow3308]

@@BoualiAli Thank you so much. I am looking forward to watching it!

[@sho.sus.0023]

As always very detailed and awesome video. Subscribed!

[@BoualiAli]

Thanks and welcome

[@mrcoder9401]

Salam, Wonderful content Ali. You are such an amazing mentor. Love to see more coming.

[@srirampant3135]

Thanx bro for your amazing videos, You were a big help to me as I was scratching my head in swagger-ui-2 , gettting muddled over annd over again.

[@BoualiAli]

Happy to help!

[@mostafamayou756]

You're just amazing!

[@LePhenixGD]

Amazing tutorial mate!

[@SamanSarafraz]

It was one of the best tutorials in Swagger and I appreciated your efforts 🥰👍👍👍

[@BoualiAli]

Thank you so much 😀

[@rakshitshetty7004]

amazing tutorial thanks buddy you solved the issue i was looking for very clear concise

[@BoualiAli]

Glad it helped

[@RoxDelas]

thanks bro, high quality!

[@BoualiAli]

Happy you liked it!

[@user-og7de8ih4f]

Very informative & complete video on swagger ui .. Thanks for this awesome videos 🔥🔥

[@BoualiAli]

Really happy you enjoyed it

[@predragradojicic5829]

Great tutorial. Thank you!

[@BoualiAli]

Glad you think so!

[@samuelstefancic8050]

Quel monstre, merci !

[@BoualiAli]

Thank you

[@khalilbouali3480]

thanks a lot Ali, it was very helpful !

[@BoualiAli]

Glad to hear that!

[@luishenriquedossantos8183]

Very good video my friend! Thank you very much!

[@BoualiAli]

Thank you! Cheers!

[@fadelkouyate1523]

Great content, thank you 🤩

[@BoualiAli]

my pleasure. Happy you liked it

[@anjanx44]

Your presentation is really awesome.

[@BoualiAli]

Happy you liked it

[@ainigma100]

Thank you for the great video!

[@BoualiAli]

Glad you liked it!

[@funnychannel1888]

Beautiful

[@user-ku7dh7od7i]

best spring boot teacher ever

[@BoualiAli]

Really happy you liked it

[@temrimoose]

Thank you so much bro for this super video 😊😊

[@BoualiAli]

Really happy to help.

[@larcomdev]

Video was super helpful, thumbs up my friend!

[@BoualiAli]

Glad it was helpful!

[@vageeshanvageesh5583]

Great content, thank you man ❤

[@BoualiAli]

my pleasure. Happy you liked it

[@vageeshanvageesh5583]

@@BoualiAli can we protect the api docs with basic auth for additional security?

[@arek9430]

Golden content, thanks!

[@BoualiAli]

Happy you liked it!

[@hatembenechikh7035]

you are saving lives , really thanks

[@BoualiAli]

Glad you liked it!

[@thenriquedb]

Great tutorial, thank you very much

[@BoualiAli]

Happy you liked it!

[@Olivier-Patrick]

great !

[@boubakerjrad5002]

Thank you man good work

[@BoualiAli]

Happy you liked it

[@doomdota2641]

great video ! clear explanation , thanks like it

[@BoualiAli]

Glad you liked it!

[@tianadede349]

trop fort le mec, thank you

[@BoualiAli]

Welcome!

[@Im_not_scareddd]

Nice stuffs ❤ Keep going man

[@BoualiAli]

thanks. Happy you liked it

[@DiplomasizKodcu]

ohh thanks so much. This is now working...

[@BoualiAli]

Enjoy

[@kkmprod]

thanks for this amazing tutorial 🙏🙏🙏

[@BoualiAli]

Glad it was helpful!

[@AmadouSene-kn5pi]

very interesting, thank you for this video

[@BoualiAli]

my pleasire

[@girishanker3796]

This is gold

[@BoualiAli]

Happy you liked it!

[@ankitasthana7822]

Awesome video.. informative 👍

[@BoualiAli]

Happy you liked it

[@KuchNahiBasAiseHi]

Amazing video..thanks a lot.

[@BoualiAli]

Glad you liked it!

[@soyjaider8996]

just that i need it, great video new suscriber

[@BoualiAli]

Thanks for the sub!

[@sreetamasaha3399]

Thank you 😊

[@BoualiAli]

Happy you liked it!

[@leekbiel]

Thank you!

[@BoualiAli]

welcome

[@dagnogoyaya5639]

🥰 Very happy thanks you sir

[@BoualiAli]

my pleasure

[@mahgsvtshh5444]

Very Helpful

[@BoualiAli]

Glad you liked it!

[@theparten]

very intuitive❤...

[@BoualiAli]

thanks

[@babacarmane5434]

Merci beaucoup 🎉

[@BoualiAli]

Really happy you liked it

[@BeingDeveloperWithAB]

Very useful details.

[@BoualiAli]

Glad you liked it

[@mustaqimahmad1504]

I am became your fan now.🙌

[@BoualiAli]

Welcome to the family

[@AmirElkased]

Thanks Bouali ❤❤

[@BoualiAli]

Happy you liked it!

[@KhoiNguyen-lb4lc]

Thank you so much....

[@BoualiAli]

my pleasure

[@rediensE.]

I don't speak English, but I understood everything, Gracias!

[@BoualiAli]

Glad I could help!

[@ib-tihadj6199]

Thank you

[@BoualiAli]

my pleasure

[@crazyidea9143]

you are amazing..

[@BoualiAli]

Thank you so much 😀

[@orinda.harrison]

Thanks

[@BoualiAli]

Thank you and I really appreciate your support

[@anjanx44]

We need more spring boot 3 tutorials like this.

[@BoualiAli]

Thanks. Please let me know what you want to see next

[@anjanx44]

@@BoualiAli microservice

[@BoualiAli]

@@anjanx44 already published

[@ismailforeveryone6889]

Amazing content please keep going and please try to mention all things that sould not be in production

[@BoualiAli]

Sure I will

[@ismailforeveryone6889]

@@BoualiAli Thank you so much

[@niteshyadav7819]

Hi Ali, how can we provide desired custom example value to the endpoints which we want as a reference to the user about what to expect ? Your videos are great btw.

[@BoualiAli]

Here is an example for that @GetMapping("/yourEndpoint") @ApiOperation(value = "Your endpoint operation", notes = "Additional notes about the endpoint") public ResponseEntity yourEndpoint( @ApiParam(value = "Example value for parameter", example = "exampleValue") @RequestParam String parameter) { // Your implementation here return ResponseEntity.ok("Response"); }

[@levibaraka]

Thank you for this video it was really helpful. I have one question though how do I make it work for functional endpoints because I tried using the examples in the documentation

[@BoualiAli]

Can you please explain a bit more?

[@sgaurav35]

Can you make a small video on explaining about the Schemas in Swagger UI and how to make changes to it.

[@BoualiAli]

Can you please tell me more?

[@norulshahlamjohn1140]

thank you for the video! is there a way you could make a tutorial on java based approach instead of this annotation approach? i prefer the former as i can inject values from property files into the swagger config

[@BoualiAli]

Great suggestion!

[@user-hq7cx8kb8q]

Hi bro, can u please provide a tutorial on Apache Camel Integration Framework. for eg: (rest.xml and route.xml)

[@hanumanthram6754]

Could you also cover @ApiResponses and @Pattern and validations of request body?

[@BoualiAli]

You can check the documentation for that

[@Antonio-wc6rr]

Thanks for the video. I implemented it in my project. I want swagger to not make real calls to the database in the prod environment(it's fine in other environments), but simultaneously, I want to have real calls to the database in prod if, for example, I hit the endpoint with Postman. Is there a way to achieve this?

[@BoualiAli]

Swagger is not responsible for making calls to the database. It acts exactly like postman. Also it is not always recommended to expose the swagger for prod. Pre-prod or dev environment are enough

[@shakamuhammed533]

Hello Ali, can you create a video on Angular e-commence full stack application.

[@BoualiAli]

Already working on it

[@a7mdFathii]

first thanks for this wonderful tutorial 😀 I had a small issue in using magement APIS. i get 403 with this test when debug Responding with 403 status code Securing GET /error Set SecurityContextHolder to anonymous SecurityContext Pre-authenticated entry point called. Rejecting access also this only happen with this controller others work perfect and my user is admin also i check the code from repo and i cant find anything.

[@user-ew6rn2my7u]

What if I want to change the title of a web page in the window? (Swagge UI )

[@harinathmarasani]

Its an excellent video on openapi. but i have a problem in my application like In my RESTController. i have 4 end points and. i need to pass JWT token only for 2 endpoints as part of request header. How can i achive this pls ?

[@KumarR-ps3be]

How do I get that URL link (server / UAT) from application.properties file for open API annotation. @value is showing error

[@syedsharyarjavaid9853]

I still get cannot load API definition even though I did permitAll() on all those URLs.

[@denismurashko843]

Thanks for the video. Can I somehow download the specification, for example, when executing the gradle task?

[@BoualiAli]

Yes you can! You can use the openApi plugin to generate and download the specification

[@denismurashko843]

@@BoualiAli Thanks. I have done it. Is it possible also to download somehow the swagger-ui.html?

[@mosestechtalk]

Thank you sir for this awesome tutorial, please how do I go deploy the swagger file?

[@BoualiAli]

where to deploy it?

[@philong7490]

Hi Ali! I see some projects which use OpenApi auto generate Controller included Swagger Documentation just by define information in api.yml file. So, I'm very confused with it. Do you think this is the good way? And do you know what way people use to document API nowadays? Sorry for my bad English!

[@BoualiAli]

No worries your english is good. I get your answer and this was a topic for a long discussion with some experienced developers / architects. I will make a video soon explaining this topic and its advantages and disadvantages

[@mohammadasif5798]

Thank you so much. It would be more helpful if you bring spring boot projects

[@BoualiAli]

Sure thing!

[@mohammadasif5798]

@@BoualiAli thank you

[@rustamsaydam]

I do not see my token in my RUN, how i can do this? i used token in register place, but i am also get the error 403...

[@safarboyalkhwarizmi]

What is your intellij theme by the way? I really like it

[@BoualiAli]

Thanks, this is the new theme from the newest version of Intellij

[@restlesschief]

Can you share some insight into how we can inject some custom CSS in swagger ui ?

[@BoualiAli]

I never tried that. But, why do you need that?

[@DanielPicuasi]

Hi BoualiAli, I have a question, if I have an architecture in which I have configured, spring config server, spring eureka, spring api-gateway, spring security for auth with jwt, and I have several microservices that are within this architecture, how or where they should configure swagger so that it recognizes all the documentation of all spring boot microservices?

[@BoualiAli]

In the api gw

[@eddykokokenfack1362]

Like you said, how to generate automatic openapi docs to angular? Still pleasure of watching your content

[@BoualiAli]

Coming soon

[@fufufifi2349]

I'm also interested please

[@user-zl2ff3eh4o]

Hi Ali, how can i hide the '/v3/api-docs/ Explore' section and the 'Servers' section on Swagger UI?

[@BoualiAli]

I never tried that. Let me check and come back to you

[@KlanBr1]

In a post method, is it normal for the swagger to see empty parameters if I specify that it has a @RequestBody?

[@BoualiAli]

Nope, it should not

[@maid768]

In my swagger openapi v3 the order for endpoints is very different from yours. It shows PUT-Requests first, then DELETE and then GET. How do I get the order GET, POST, PUT, DELETE? Some say it's naming order is asc, but in your example m(anagement) comes before a(dmin) eventhough in alphabet a comes before m

[@BoualiAli]

Check the documentation for ordering the endpoints

[@xxyz9819]

Can you make one on how to set OAuth2

[@BoualiAli]

Already done. Check the playlists

[@VillaneaPablo]

beautiful pom.xml file which theme do you use?

[@BoualiAli]

Default theme from the new version of intellij

[@beingsks457]

Hi ali , thanks for this session .if our code is deployed on cloud like azure how can i acess tge swagger through actual ip or actual url rather than localhost can u help me on that

[@BoualiAli]

You can

[@beingsks457]

@@BoualiAli can you guide me or help me on that how to acces th swagger ui after deployment .is there any existing video available or any article.please help.

[@samirallahverdiyev99]

Please help me.İ get no operation defined in spec in swagger when add this dependency but server is correct

[@BoualiAli]

Can you show more details? Post on discord server with screenshots

[@daboarder]

Does this work with Gradle? I cant find an Implementation to get Swagger UI running.

[@BoualiAli]

yes it does

[@anhnguyen1701]

how to make output colorful like you

[@schoolbook1]

Can all of this work with Spring Webflux? I like your videos.

[@BoualiAli]

I need to check it first. I never tried that

[@schoolbook1]

Do you have udemy courses for spring boot or docker/kubernetes?

[@BoualiAli]

yes, check aliboucoding.com/courses

[@pabitrabera5454]

Sir can you help us for free internship. Where to find and how to apply in spring boot and microservices with spring cloud and spring related.

[@BoualiAli]

Follow me on social media. if I have something I will share it there

[@BeingDeveloperWithAB]

Which is your intelij Theme?

[@BoualiAli]

The default theme from the latest version

[@afermeherremova5672]

Where is the video about permissions, roles, authorizations? i can't find it

[@BoualiAli]

In the playlist

so slow and crashing with spring boot 3. also Init duration for springdoc-openapi is: 42494 ms

[@abdallahissaal-kass9092]

Can we create custom @ApiResponse for example @OkApiResponse (with 200 and OK)?? If yes how?

[@BoualiAli]

yes you can, Just create an annotation and add @ApiResponse with status 200 on top of it