Spring Boot | Documenting Microservice Using OpenAPI 3.0 specification | javatechie

Documentation is an essential part of building Microservice/REST APIs. In this tutorial, we'll take a look at SpringDoc — a tool that simplifies the generation and maintenance of API docs, based on the OpenAPI 3 specification

#javatechie #SpringBoot #openAPI #Documents #Microservice

GitHub:

Blogs:

Facebook:

guys if you like this video please do subscribe now and press the bell icon to not miss any update from Java Techie

Disclaimer/Policy:
--------------------------------
Note : All uploaded content in this channel is mine and its not copied from any community , you are free to use source code from above mentioned GitHub account

[rush]

Java Techie's videos are most accurate, to the point and very informative.
Thank you very much!

[priyankabhagwat]

Thank you so much for making the video on OpenAPI, even though after seeing your video I realized its its very easy but before watching that I struggled a day for getting the right dependency and I am getting 404 for both URLs, but your video helped me to implement it quickly.

[NomadicBrian]

I really like Swagger. Java Spring Boot is doing a great job with OpenAPI. Services should never be a mystery.

[rohitnegi]

Thank u very much for such informative video. Very helpful

[bathulanagendra]

Nice video sir.no need to add multiple swagger dependencies and no need of java configuration.Thanks a lot.

[sarojsahoo]

Try ading json formatter plugin in browser so you can see a pretty json string in browser too

[weitanglau]

Do you happen to have a version for microservices? Where we use Spring Cloud Gateway to have all the APIs of all microservices

[FarheensVlogg]

What is intention of adding openAPI? Is it required to create documentation so we can share with other team to consume later.

[fullfun]

Dear you doing great work. Please let us know to add global header textbox to swagger

[naadiyaafreen]

For me, localhost:8080/v3/api-docs is giving whitelabel error, , could you please help me with that

[VikramKumar-oulh]

I did the same thing but my paths and components are empty. "paths":{}, "components":{}. I created my via API-First Development with Spring Boot and Swagger. Please suggest.

[TusharSachdeva]

What if our controller class is using jersey based annotation and project uses gradle, what to do in that case?

[ainigma]

If the API has security enabled, how can we access the documentation? I saw online that somehow when someone tried to access the documentation there was an Authorize button with a lock 🔒. When they pressed the button, they could provide the JWT Key. Another video was using OAuth2.0 and he was using client_id and client_secret.

[aruhiayaanreddy]

How can generate error responses using code, I mean I am using maven open api plugin generating apis(interface which have all APIs), after that I added OpenApiConfig Java class which OpenApi components etc. After run the application and hit the swagger-ui.html I got only Api success response with description default response but I didn't get the Error response and also when using with that open Api plugin the generated classes have io.swagger.annotations instead of OAS3 annotations.
Do you have any solution if you have please let me know
Thanks in advance.

[kayeshparvez]

while using swagger-ui we could use swagger annotations to additional descriptions with each api endpoints. Can we do the same with open-api ?

[krishnasahu]

Can we also add OpenAPi into cloud gateway/eureka server for accessing all the microservices into single UI...?

[omkargangawar]

Very helpful video.
can you please tell how to add JWT authentication in OpenAPI specification.

[k.i.m.]

@Java Techie hi buddy, search your github repository, "openapi-example" is not existing at all

[krishnasahu]

What should I need to do for making a Centerlized openApi for all the microservices ..?

[ainigma]

Thank you for the great video! Is there a possibility that you can make a tutorial using springdoc-openapi-security? In order to add security to unlock the endpoints before you can send a request from Swagger UI.