How to document SpringBoot Rest APIs using Open API and Swagger? | SpringBoot Tutorial Part 3

How to document SpringBoot Rest APIs using Open API and Swagger?
00:00 Spring Doc Introduction
01:20 What is Spring Doc Open API Java Library?
02:40 Open API vs Swagger API?
04:10 Workshop
. Add Dependancy
. View API JSON
. Interact through Swagger API
. Advance Features

[@muhamadsalemsugui9490]

I loved your video. Your English is very clear, you speak calmly and simply. Straight to the point. Thank you very much.

[@TheodoreRavindranath]

Really thorough presentation, with practical tips. Thanks!

[@alwisnishantha]

Amazing, presentation is very simple, any one can catchup open API concept and implementation, thank you much

[@ravikumarkumashi7065]

Thank you for the vedio...simple and easy to understand

[@peterveres560]

Thank you for the video. Beside the fact that it was informative your kind tone of voice just brightened my day a bit :)

[@SagguUK]

Thank you for your kind words.

[@sp2024_1]

Thanks for this tutorial. I recently tried springdoc-swagger-ui but swagger UI hangs whenever I test an endpoint which returns a large response back. Can you pls suggest a workaround for this?

[@DavisTibbz]

Beautiful

[@JoaoVictor-uo4dn]

Hello, does the yaml/json file get stored somewhere?

[@krishmails]

how to write webhook using spring boot to get the json data from Microsoft apis
could you put a video or give me sample code

[@vinkenwood8233]

It is nice, but...ni title is "How to document", but I dont see any document in the video. Your wrote it by hand?

[@ainigma100]

Thank you for your video! How can we secure Open API and use a JWT token to send requests from Open API?

[@SagguUK]

OpenAPI uses the term security scheme for authentication and authorization schemes. OpenAPI 3.0 lets you describe APIs protected using the following security schemes:
A. HTTP authentication schemes (they use the Authorization header):
1. Basic
2. Bearer
3. other HTTP schemes as defined by RFC 7235 and HTTP Authentication Scheme Registry
B. API keys in headers, query string or cookies:
1. Cookie authentication
C. OAuth 2
D. OpenID Connect Discovery

[@ainigma100]

Thank you

[@tonyboltz8411]

nice tutorial, can u help me : where can i find swagger annotations documentation?

[@SagguUK]

Try this: springdoc.org/

[@gauravjaiswal9808]

how to add centralized swagger in micro-services?

[@TheBooban]

Your page is still default OpenAPi definition and the badges default. How to adjust this please? Properly.

[@SagguUK]

See this: springdoc.org/index.html#how-can-i-configure-swagger-ui

[@benjaminfrank9166]

by default swagger ui uses http protocol to connect with backend but my application on cloud uses https protocol. So that if i execute the try out i am getting an error as unauthorised. Can you please tell me how to change swagger UI protocol from http to https?

[@daniyalmujtaba]

Hello, I am trying to set this up and I have gone throught documentation but cant resolve the error
whenever I am hitting the localhost:8080/myapp/swagger-ui.html I am directed to a plank page . I can access v3/api-docs.
Please let me know if you know solution.
Thanks