Thanks Kaushik for such informative tutorial, in case someone is using this to document an API and, after creating the Docket, finds out that the child endpoints for inner API calls are missing (i.e. api/contact/{id}) just change the ant match in the Docket object to /api/**. Good Luck!
Hello Koushik ! I would like to take this opportunity to appreciate the informative videos which you have been doing. Yes, The Viewers of your tutorial series will owe a lot a for ever. You are far way more than my words can describe. I will be looking forward to your next tutorial uploads.I gained good knowledge with your style of training... Thanks,Abid.
The final minute of this video is key because that’s the exact same reason why I don’t use swagger in my projects. After some detailed information added to each class and methods you end with a bunch of annotations that makes your code unreadable. At this moment I use Spring Rest Docs (Ascii Doc) for documenting the API. With the last approach you get a win win scenario where the documentation is the direct result of making test unit cases. Amazing.
Thank you Kaushik for the video. Last two were amazing, as always. I personally have been to that "Annotation Hell" :D . However, I didn't know about REST Docs, so what I did was to write a custom Swagger processor (which Swagger provides) for the custom annotations I have created. so let's say my @ApiParam was very long and duplicated over the code (like for example to describe the Id field ), I would create another annotation let's say called @Id and put everything to it, then do the processing elsewhere. It is more readable, and less verbose. However, it requires extra manual processing (which is not a big deal, tho)
Hi Kaushik, Thanks for the video. It was really helpful. Request you to create videos for micrometer with spring boot or how do we expose custom metrics using micrometer to prometheus or grafana dashboard. Thanks agin
Hello Koushik. Your videos gives a clear understanding of the concepts. Thank you very much for your help to the java engineers community. You are simply awesome.
Hi Koushik! Thanks for the video. It will be great to have a video on swagger code gen (Open Api) as a part of swagger series. Looking forward for more informative videos from you. Thanks again.
i am struggling to find one right now, did you end up finding a tutorial on swagger code gen ? For me to be able to generate the API code from a yaml API contract. Thanks :)
Hi Kaushik, Thanx for the tutorial. May you kindly do the YAML based configuration for swagger. I heard about it but I'm having a hard time finding a good tutorial/good documentation on it. but I'm sure it will address the annotation hell problem you mentioned towards the end of your video
please release spring rest docs as soon as possible sir.... and thanks for your help .. u have been an inspiration with the way u teach the quality of video and explanations
Hi! How can I group the endpoints? Let's say I have "/management/**" and "/external/**" mappings from different controllers. Then from the SwaggerUI, I can select the group from the definition dropdown select.
If you have given a @RequestMapping annotation with no arguments, you will need to change to specify the method type, so Swagger can understand the type of the http method. e.g. @RequestMapping(method = RequestMethod.GET, value="/users/{userId}")
Hi Koushik! Thanks for the video. Can you please make a video on how we can have a common swagger documentation page for multiple micro services. In real world we are having a lot of micro services and we do not wish to maintain swagger doc for each micro service since its tough to share different swagger URLs to the clients.
hey does anyone know how can I send custom header with my request in swagger-ui sprinboot if I have a path /{userId}/{productId} I need to send user id and productid with request
Hey Kaushik, I have request .. Can you make a detail video tutorial on Authentication and Authorisation using Springboot mvc ? please request from old subscriber.
Thanks. Frequently, service providers should design and present the api documentation to consumers in advance before starting development. Can you please tell a best way to address it with the approach of swagger in-code you demonstrated or REST docs?
Swagger kinda assumes that you have at least some methods on your controller in order to annotate. My recommendation would be to create method stubs that represent your API as per design and annotate them with Swagger annotations. You can then do development in parallel
We use Swagger quite a bit, and we take an API-first approach, like you are describing. Using swagger-codegen, you can develop your API first in OpenAPI spec YAML. Then feed it to swagger-codegen to generate code based on your API. This has many benefits for us, one of which you highlight in your question: we can share the documentation prior to writing any code to vet the API. This means you will have to configure swagger-codegen to produce what you want as opposed to the Docket thing described in the video... the configuration is a flat file used by swagger-codegen to use the libraries you want, naming schemes you need, etc.
Thanks for awesome. Can you make a video how to configure swagger in jax-rs maven application and generate swagger-ui.html file. Because as of now no one uploaded any video/tutorial on it
By default swagger UI using http protocol, My application only allows https requests. If i click execute on try out, i am getting 401 (unauthourized request). Can you/anyone please tell me how to have this swagger UI to use https protocol.
I am not able to see the "paths" onlytill base path is present and in swagger ui i am getting this "No operations defined in spec".. can someone tell me what might be the issue.. i didn t get much help from google
Maybe you did not put your package path correctly in the .apis(RequestHandlerSelectors.basePackage("PUT YOUR BASE PACKAGE PATH HERE")) In the current video, the basePackage path was "io.javabrains". But your base package most probably is different.
Nicely explained swagger. But have you created video on Spring REST Docs. Because i could not find it in your channel. At the end of this video still say coming soon. If you have created please provide link here. Thank you.
Thanks a lot, sir for your informative video. Because of great programmers like you, we newies could learn something interesting and something new each day. Thanks a lot, sir.
Hello Koushik, can you also explain how to give headers in swagger? Like giving "Authentication" header. so that I can specify it once and it can be applied to all APIs.
You carried me on your back to get my first job. God bless you!
P8i8+ki
Jiii
2:33 - Customizing swagger with, "DOCKET" configuration.
7:23 - Adding application metadata to swagger.
10:42 - Adding more details to API.
Thanks :)
Awesoem, thanks
Thanks Kaushik for such informative tutorial, in case someone is using this to document an API and, after creating the Docket, finds out that the child endpoints for inner API calls are missing (i.e. api/contact/{id}) just change the ant match in the Docket object to /api/**. Good Luck!
Hello Koushik ! I would like to take this opportunity to appreciate the informative videos which you have been doing. Yes, The Viewers of your tutorial series will owe a lot a for ever. You are far way more than my words can describe. I will be looking forward to your next tutorial uploads.I gained good knowledge with your style of training... Thanks,Abid.
One of my best RUclips Tutor ever!...Kudos!!!!!!!
The final minute of this video is key because that’s the exact same reason why I don’t use swagger in my projects. After some detailed information added to each class and methods you end with a bunch of annotations that makes your code unreadable. At this moment I use Spring Rest Docs (Ascii Doc) for documenting the API. With the last approach you get a win win scenario where the documentation is the direct result of making test unit cases. Amazing.
I felt the same about detailed info added to each class. It´s terrible.
Followed and completed the POC on Spring boot + Swagger, awesome explanation.Hat's off
Kaushik - a gem of a tutor
Thank you Kaushik for the video. Last two were amazing, as always.
I personally have been to that "Annotation Hell" :D . However, I didn't know about REST Docs, so what I did was to write a custom Swagger processor (which Swagger provides) for the custom annotations I have created. so let's say my @ApiParam was very long and duplicated over the code (like for example to describe the Id field ), I would create another annotation let's say called @Id and put everything to it, then do the processing elsewhere. It is more readable, and less verbose. However, it requires extra manual processing (which is not a big deal, tho)
Hi Kaushik, Thanks for the video. It was really helpful. Request you to create videos for micrometer with spring boot or how do we expose custom metrics using micrometer to prometheus or grafana dashboard. Thanks agin
Waiting for Spring Rest Docs!
Me too .
Please 🙏.
Waiting !! me too sir
Hi Kaushik, really thanks for your videos, I am following you since 2014 and you rock man !! (y) .. keep it up :)
Hello Koushik. Your videos gives a clear understanding of the concepts. Thank you very much for your help to the java engineers community. You are simply awesome.
Your videos helped me alot. Thank you
Hi Koushik! Thanks for the video. It will be great to have a video on swagger code gen (Open Api) as a part of swagger series. Looking forward for more informative videos from you. Thanks again.
i am struggling to find one right now, did you end up finding a tutorial on swagger code gen ? For me to be able to generate the API code from a yaml API contract. Thanks :)
Hi Kaushik, Thanx for the tutorial. May you kindly do the YAML based configuration for swagger. I heard about it but I'm having a hard time finding a good tutorial/good documentation on it. but I'm sure it will address the annotation hell problem you mentioned towards the end of your video
+1
Excellent explanation. Very well done.
Amazing Content Sir
Thank you so much for the video.
Very Informative and great precise explanation of concepts. Thank you !!
Can you explain how api key authentication to be used in spring mvc
please release spring rest docs as soon as possible sir.... and thanks for your help .. u have been an inspiration with the way u teach the quality of video and explanations
thanks a lot Koushik!
Thanks for your video, you are one of favourite, if possible one video about type script new features and usage.
Realy very helpfull tutorials!! Thanks !!
Thank you. simple and understandable.
Can't thank you enough, Kaushik!
you are great teacher !
in ant pattern there should be "/api/**", not "/api/*", i have faced the problem where
swagger didn't see any of my endpoints because of one missing *
you solved my issue. Thanks @ATA Man
Excellent!
Thanks a lot Kaushik! It would be great if you could put your code in any repository so that anyone can refer/download it. Thanks again!
Pls make java for intermediate developers
We added it to our Microservices how do I make it work in Kubernetes? Any suggestions?
You can create API using YAML and generate Spring boot application out of API and it fulfills API first strategy
Hi! How can I group the endpoints? Let's say I have "/management/**" and "/external/**" mappings from different controllers. Then from the SwaggerUI, I can select the group from the definition dropdown select.
Thank you so much! Very useful!
Excellent video with excellent content!!
In 11:08 what make lin 27? on swagger open api3.0???? "provide an id to look up specific....."
How to Enable Swagger in the multimodule application. But it's not showing documentation when adding configuration in separate config file
great video thanks
Good job, thanks
Thank you kaushik.
when configured i am still getting extra head,options,patch fields which are not necessary. How to remove them from swagger?
If you have given a @RequestMapping annotation with no arguments, you will need to change to specify the method type, so Swagger can understand the type of the http method. e.g. @RequestMapping(method = RequestMethod.GET, value="/users/{userId}")
I want to redirect the default url 'localhost:8080/swagger-ui.html/' into 'localhost:8080/swagger/swagger-ui.html/'.... how can I do this?
Thank you so much Sir.
Thanks for your work!
You are AWESOME!
Hi Koushik! Thanks for the video. Can you please make a video on how we can have a common swagger documentation page for multiple micro services. In real world we are having a lot of micro services and we do not wish to maintain swagger doc for each micro service since its tough to share different swagger URLs to the clients.
followed ur steps but when i am adding .paths() and .apis() .... i am getting "No operations defined in spec!" on browser
Thanks for this wonderfull tutorial Kaushik. I have one question, what is the annotation to change address-book-resource?
Grazie.
Thank you very much.
hey does anyone know how can I send custom header with my request in swagger-ui sprinboot
if I have a path /{userId}/{productId} I need to send user id and productid with request
Hey Kaushik, I have request .. Can you make a detail video tutorial on Authentication and Authorisation using Springboot mvc ? please request from old subscriber.
Thanks. Frequently, service providers should design and present the api documentation to consumers in advance before starting development. Can you please tell a best way to address it with the approach of swagger in-code you demonstrated or REST docs?
Swagger kinda assumes that you have at least some methods on your controller in order to annotate. My recommendation would be to create method stubs that represent your API as per design and annotate them with Swagger annotations. You can then do development in parallel
We use Swagger quite a bit, and we take an API-first approach, like you are describing. Using swagger-codegen, you can develop your API first in OpenAPI spec YAML. Then feed it to swagger-codegen to generate code based on your API. This has many benefits for us, one of which you highlight in your question: we can share the documentation prior to writing any code to vet the API.
This means you will have to configure swagger-codegen to produce what you want as opposed to the Docket thing described in the video... the configuration is a flat file used by swagger-codegen to use the libraries you want, naming schemes you need, etc.
This was very informative. Thanks for your comment!
Thanks for awesome. Can you make a video how to configure swagger in jax-rs maven application and generate swagger-ui.html file.
Because as of now no one uploaded any video/tutorial on it
@@JosephRios Great to know that! Tks for sharing!
Not able to open swahger ui...it is showing unable to infer base url...
Where you got "/api/*" that declare on paths(PathSelector.ant())
Cool !! Thank you !! 👍
Thank you so much !
Do you have a video on authorization?
By default swagger UI using http protocol, My application only allows https requests. If i click execute on try out, i am getting 401 (unauthourized request). Can you/anyone please tell me how to have this swagger UI to use https protocol.
Great explanation
Hi Kaushik, can you please have the springboot IDE be having a white background instead of the darkmode. Its very difficult to view on small screens.
Hello,
Can we add swagger at Could Gateway API?
Please use light background with little big font size.
Hi sir can u make a video regarding jwt token authentication with swagger so can i access the swagger ui. Html by providing the bearer token
How does one get swagger ui make HTTPS calls instead to HTTP? Thank you ...
Nice tutorial. I need to configure swagger in my spark web . I didn't find any tutorials . Appreciate any help
Hi Kaushik,
Is there any way to get the API documentation in doc or pdf format?
Annotation hell. God I don't like Hapi but damn I miss using Joi library. I do not miss ceremonies in Java.
when i try open swagger-ui.html showing white label error page
Thank you so much for the video.
Waiting for Spring REST DOCS video.
can we use spring rest docs without writing test cases?
Thank you Kaushik for all the awesome videos. May I know what are the tools used to make the whiteboarding part of your videos
Good one...
Please can you make a tutorial about creating documentation of a rest api created with spring data-rest? And good video!
/rest/** if you have api urls of type /rest/some/thing, because /rest* (one asterisk) works only for /rest/some
why these videos on swagger are not on the playlist of javabytes??????
I am not able to see the "paths" onlytill base path is present and in swagger ui i am getting this "No operations defined in spec"..
can someone tell me what might be the issue.. i didn t get much help from google
Maybe you did not put your package path correctly in the .apis(RequestHandlerSelectors.basePackage("PUT YOUR BASE PACKAGE PATH HERE"))
In the current video, the basePackage path was "io.javabrains". But your base package most probably is different.
Nicely explained swagger.
But have you created video on Spring REST Docs.
Because i could not find it in your channel. At the end of this video still say coming soon.
If you have created please provide link here.
Thank you.
Please make a video on Spring Rest Docs Sir!!
getting 404 error when hit localhost:8080/swagger-ui.html
this works with java 11 ?
Thanks a lot, sir for your informative video. Because of great programmers like you, we newies could learn something interesting and something new each day. Thanks a lot, sir.
Hello Koushik, can you also explain how to give headers in swagger?
Like giving "Authentication" header. so that I can specify it once and it can be applied to all APIs.
Thnx sir
Awesome by the way which theme you are using for intellij
hi kaushik,
Do you have already tutorial on Swagger code gen tool?
why request body listing under parameter in swagger
Hi please change the IDE look n feel as its blackish color make the visibility very low
Can I request to use ide with white background for more clarity
Sir, do you take 1- 1 courses
Please provide tutorials on raml documentation n designing.
how to change logo and word swagger with your own?
how to pass Bearer token details in swagger
2:33 -Customizing swagger with, "DOCKET" configuration.
How to disable Try it out button ?
how to hide the Model information from swagger API
add defaultModelsExpandDepth: -1
Could you please give ur mail id . So that I can connect you when I have doubts . thanks for this video for swagger .its a great learning tutorial.