REST API Documentation using Swagger2 in Spring Boot | Tech Primers

This video covers how to integrate Swagger 2 UI for REST API Documentation in Spring Boot.
🔗GitHub Link for the code: github.com/Tec...
📌 Related Playlist
================
🔗Spring Boot Primer - • Spring Boot Primer
🔗Spring Cloud Primer - • Spring Cloud Primer
🔗Spring Microservices Primer - • Spring Microservices P...
🔗Spring JPA Primer - • Spring JPA Primer
🔗Java 8 Streams - • Java 8 Streams
🔗Spring Security Primer - • Spring Security Primer
🔗Containers Primer - • Containers Primer
🔗Kubernetes Primer - • Kubernetes Primer
🔗AWS Primer - • AWS Primer
💥Join TechPrimers Slack Community: bit.ly/JoinTec...
💥Telegram: t.me/TechPrimers
💥TechPrimer HindSight (Blog): / techprimers
💥Website: techprimers.com
💥Slack Community: techprimers.sl...
💥Twitter: / techprimers
💥Facebook: TechPrimers
💥GitHub: github.com/Tec... or techprimers.gi...
🎬Video Editing: iMovie
🎼Background Music: Broke For Free - Day Bird
brokeforfree.b...
The Passion HiFi - What We Came To Do
---------------------------------------------------------------
🔥 Disclaimer/Policy:
The content/views/opinions posted here are solely mine and the code samples created by me are open sourced.
You are free to use the code samples in Github after forking and you can modify it for your own use.
All the videos posted here are copyrighted. You cannot re-distribute videos on this channel in other channels or platforms.
#Swagger2 #SpringBoot #TechPrimers

[@rohitkr.maurya6917]

Your video is like any beginner can easily understand....Thanks for your effort

[@ItamarLev]

great tutorial! after days and days of looking for a good explanation you did it in less than half an hour. thank you!

[@TechPrimers]

Cheers mate

[@sateeshkumar-sy2pc]

Explained in a very simple way. Tried once and executed. That's all.... Thank you...

[@muks]

Dude, Few points 1. The background is really awesome, 2. I really learned some good stuff although I know swagger2, 3. You need to explain in the swaggerConfig what is regex and how did you coded for it? because default paths only accepts the PathSelectors, 4. Some of the attributes have changed For e.g. description for @Api OR ApiInfo constructor args have changed but i guess you are unable to update the videos which is understood considering the vast no. of videos you are making, 5. Hands down very good videos for anybody to keep learning. Thanks a lot.

[@muzammilsiddique2821]

This session is a great learning guide for generating API documentation from Spring boot project. Please plan a session on building API documentation from swagger editor and then build an API based on that documentation

[@suddewar]

Explained in very clean and precise way. Thanks

[@andrzejokon1517]

I use all technologies you talk about in your videos:) Great tutorial. Thank you.

[@TechPrimers]

+The Hedgo thanks dudr

[@maxlimgj]

Awesome explaination! Looking forward to more content

[@kev18284]

Very clean and precise tutorial!

[@invisibler3]

simple and nice explanation step by step

[@Premkumar-ln7gt]

simple and easy....thanks sir ji..

[@VIGNESHRUpendiran]

Wow,you again proveed buddy,i learned new things from u...I gave u thumpsup..Keep rocking...

[@TechPrimers]

+VIGNESH R thank you Vignesh. Happy Learning

[@78tomke]

Thanks, mate. It was a pleasure to watch it. Excellent job very informative ;)

[@dakshu11]

Thanks for the tutorial, my rest api just accepts query parameter i.e ?param = value, so I don't want swagger to ask for any parameters, how can I do that.. Plz help

[@mohamedgoher9727]

The video is neat and untidy

[@photo_lab4095]

Great Tech Primers good job please make more video on Rest Webservices with Spring Rest WebServices

[@TechPrimers]

sure ramjeet. any specific usecase you want me to cover?

[@photo_lab4095]

Recently I attend one interview he asked me to represet the EntityEndPoint in Rest API but I didn't get the question it self so I want to learn besic Rest Full or Spring Rest webservice with example. & Thanks for response.

[@TechPrimers]

EntityEndPoint is the Endpoint exposing your entity(eg Users).

[@gokuldighe9160]

Thank you ..very informative and detailed one indeed

[@krishnamr6608]

Great Video. Simple and good. Keep doing.

[@kodosaru]

Nice tutorial. Thank you!

[@nitsbobby]

Good Video and very easy to understand. Thanks for this tutorial. Thanks Bro.

[@Rishi_Ventrapati]

Good information for beginners. Grate video

[@sathishrao7926]

Quite a comprehensive information through good explanation..

[@busbusvlog]

Thank you for the video. It helped me a lot :)

[@mosabkamal]

nice and it's very clear video, Thanks a lot :-)

[@ILyaCyclone]

You've added 200 "Successful Hello World" at 18:13, but why it isn't in the doc at 18:52?

[@yogeshchaudhari9971]

amazing knowledgeable video... thank you so much

[@gundamaiahannamaina9273]

Nice tutorial. Instead of placing annotations in resource classes. We can create interface and place all api annotations on top of the methods in interface And implement that interface in the resource. Is this a good way of implementating swagger in separate interfaces ?

[@aneksingh4496]

Nicely explained ....can u please make videos on Rx spring

[@vndprasadgrandhi7024]

Excellent..thanks

[@anilpatil5882]

please upload videos which contains spring boot and jpa integration with curd/crud operation

[@TechPrimers]

Hi Anil, take a look at the spring boot Playlist. I have done it with Spring Data JPA examples

[@chhagansahu8920]

Great tutorial, thanks !! How can we pass custom header through the Swagger. Is it possible?

[@jribkr8501]

I would appreciate if I can get answers to the following questions: Why do you use Springfox? What would I have to do if I want to use core swagger libraries? How does it work at a higher level? Somehow everyone is eager to use Springfox. Is there a specific path where swagger docs would be generated? Is there a way to customize the path where you want to generate the doc?

[@Gabs__00]

Thank you so much from Brazil, your video help me a lot of

[@TechPrimers]

+Gabriel Tavares my pleasure Gabriel

[@balrajmys]

Awesome video :) great job :) very informative

[@nikhilnr6392]

Great video !! very informative !! One quick question - I am working on adding Swagger documentation on REST Services developed by somebody else. This REST API does not have @RequestBody annotation for the Request object. When I add @RequestBody to the Request API, the API is breaking. Therefore, how can I include the REQUEST PARAMETERS in the Swagger documentation without adding @RequestBody ?

[@zishan-khan]

hi, how can we send jwt token with the help of swagger for authentication?

[@Vihaanhyperboy200]

Another awesome video from TechPrimers. Thank you. We have implemented our REST services with OAUTH2. How to test those services from Swagger UI. I could not find much resources on it.

[@TechPrimers]

Swagger UI is just for getting documentation out of the exposed REST endpoints. you can use CURL to trigger REST calls for automated testing.

[@sathishkumar-qf6xb]

Thanks dude .very informative

[@StefanBanu]

Hi, what plugin was that automatic import in pom.xml when you just typed swaggerDependency? Or what was that?how can i type directly the name of the dependency in pom.xml? thank you,

[@harishpavant]

I am using Jersey with spring boot, I think I am getting error : bean creation failed. Do I have to do anything diffrent in this scenario. Thanks!

[@balakrishnagajam]

Great job dude

[@isidronavea7363]

Nice tutorial!

[@nikhilka9584]

Nicely explained. How can we set api headers in swagger ?

[@shivampatil5709]

video is good as well as backgroung score.

[@EnterpriseArchitect01]

I'am looking out to create Microservices documentation very similar to 'Rapid API ' i,e with get/post methods, Resource URI and testing approach with API key . Any idea, how to create such documentation ? Thanks in Advance

[@vishalthirumoorthy]

This is a great video....I also have a question here.... Can I configure my code so that it will also general Yaml file for the swagger,.... I'll use that YAML in the swagger hub and can give it to the testing team while my application runs in the cloud...

[@ManishKumar-lg9gt]

Hi Vishal, I have the same requirement. Can you tell me, did you find any solution for this?

[@parasbishwakarma5737]

Great Video .. I have one question that is if the application is using security like spring security then how the swagger authorize users. Please Suggest.

[@TechPrimers]

Swagger will internally use the secured API, so it still will use Spring Security and you wil have to set headers in the browser using REST clients

[@GauravSharma-wb9se]

how user will know request structure ?....can't it show sample request structure ?

[@TechPrimers]

Yes it does show. When you click on each endpoint it shows the structure

[@SurendraJayswal]

hi, I need to create a dropdown and based on selected value, show a different table of data. can you help?

[@srinusrinivas6101]

Thankyou helped me a lot

[@sun-prairie]

Very useful. Thank you!

[@TechPrimers]

+ennore82 glad that was useful

[@ramstube08]

It's very detailed and very good. Thanks much for the video. Can you please tell me how to hit that request URL with a java program. If you can guide me to any other resource is also good..

[@TechPrimers]

you can try googling for RestTemplate. using rest template you can hit the urls programmatically

[@saktiranjanbehera7010]

I am not able to import regex.Could you help me out.

[@photo_lab4095]

how we can add swagger ui authentication with out any credential please make one videos on this topic

[@balakajendran1]

I was downloaded source from github and imported as maven project in STS tool. The Swagger UI page loading but Rest API details not shown. Can you please help me to resolve this issue.. Anything I have to do specifically for STS tool?

[@praveenambati7804]

facing same issue, have you fixed it already ?

[@balakajendran1]

@@praveenambati7804 Download github code from this video and try it.

[@praveenambati7804]

@@balakajendran1 Thank You for your reply, I found another way to work on Swagger2. it's working now.

[@amberkumar2359]

Can you please suggest a way to access LDAP secured api with swagger2?

[@kunupat]

Good video. I have a question: if we have a set of REST microservices each running as a separate Spring boot app ( a maven project running inside docker) and if we have enabled swagger docs for each of the service, is there any way to consolidate swagger documentation of all services under one swagger UI URL?

[@TechPrimers]

nope. none yet.

[@TheShantanu30]

How to send excel in response using swagger and springboot?

[@TechPrimers]

You have to send the right headers for attachment of your csv from spring boot

[@TheShantanu30]

@@TechPrimers Thanks a lot for your reply. But the thing is what should be the typreof ResponseEntity, Will it be InputStream? If so, then how can I define InputStream in the swagger json?

[@asmatsoomro7675]

Hey the video was very helpful. I have one question though. How can we generate a yaml file from a swagger UI for your API?

[@GlebKuzntesov]

Great video!

[@bhubannayak6155]

Hi very informative video but can I have multiple registration of rest applications in one swagger UI ?

[@TechPrimers]

at this point you cannot

[@TechPrimers]

you have to leverage on API Gateways like APIGee

[@akhandpratapsingh1527]

Thanks a lot, Man.

[@fsocietyearth9091]

Just wondering, if you are coding and documenting both by yourself, then what tech writers are doing in your company?? I think this is part of tech writers

[@abhilashsulibela1414]

This is awesome! Thanks (y)

[@abinashdas5222]

How do we disable tryout and authorize options in the swagger ui?

[@gopalbarge4961]

Simply awesome

[@TechPrimers]

+Gopal Barge thanks Gopal

[@praveenambati7804]

localhost:8889/swagger-ui.html# doesn't showing any resource ..verified basepackage in SwaggerConfig seems fine according to my package names. can you please help how to fix this issue ? FYI, I followed same example

[@victorlangat856]

a wonderful one here

[@RetheeshSoman]

Great. Thanks a lot

[@vbnandu867]

what about the response model?

[@nishkarshjain5684]

Bro i did the same as u suggest but the swagger ui dashboard is not opening , its showing 403 status?? Anyone plz help??? 👆🏻

[@Almost2333]

Enter swaggerConfig and the autofill. Is Plugin? I installed Swagger Plugin from IDEA, but it is invalid. English is not my native language; please excuse typing errors.

[@TechPrimers]

its called Live Template. I have added those texts before hand so that it can paste the code wherever i need

[@Almost2333]

Thanks :)

[@ccccljk]

i can't run app in source code in eclipse, please help me

[@gururaj030]

Error starting ApplicationContext. To display the conditions report re-run your application with 'debug' enabled. 2019-10-23 23:11:22.558 ERROR 8166 --- [ main] o.s.b.d.LoggingFailureAnalysisReporter : *************************** APPLICATION FAILED TO START *************************** Description: An attempt was made to call a method that does not exist. The attempt was made from the following location: springfox.documentation.spring.web.readers.parameter.ParameterDataTypeReader.apply(ParameterDataTypeReader.java:90) The following method did not exist: springfox.documentation.spi.schema.contexts.ModelContext.inputParam(Ljava/lang/reflect/Type;Lspringfox/documentation/spi/DocumentationType;Lspringfox/documentation/spi/schema/AlternateTypeProvider;Lspringfox/documentation/spi/schema/GenericTypeNamingStrategy;Lcom/google/common/collect/ImmutableSet;)Lspringfox/documentation/spi/schema/contexts/ModelContext; The method's class, springfox.documentation.spi.schema.contexts.ModelContext, is available from the following locations: jar:file:/Users/gb047137/.m2/repository/io/springfox/springfox-spi/2.8.0/springfox-spi-2.8.0.jar!/springfox/documentation/spi/schema/contexts/ModelContext.class It was loaded from the following location: file:/Users/gb047137/.m2/repository/io/springfox/springfox-spi/2.8.0/springfox-spi-2.8.0.jar Action: Correct the classpath of your application so that it contains a single, compatible version of springfox.documentation.spi.schema.contexts.ModelContext

[@AbhishekSagar-kf8fy]

Awesome can you please make on video on debugging microservices examale

[@TechPrimers]

+Abhishek Sagar Sure

[@subash961]

I have question, Can i use swagger2 for spring MVC also? or only support spring boot?

[@mahendram6850]

Hi TechPrimers, I followed the same steps but when I try to access localhost:8080/swagger-ui.html it says 404 error. Any idea?

[@virtexamit]

Nice work !!

[@nayanrajvansh6705]

I tried using @ApiModelProperty for the complex objects in the response but it is working only for those objects which are coming as response in the form of a list but not in case of a standalone object. In the below example "List of ObejctA" is documented is Swagger but "Stand alone Object B" is not getting documented. e.g. @ApiModelProperty(notes="List of ObjectA") public List getObjectA() {. . . } @ApiModelProperty(notes="Stand alone Object B") public ObjectB getObjectB() {.......} What to do ?

[@gmsvgm]

We need to develop multiple micro services and so wanted to know if we can have separate swagger ui where documentation of all these micro services can be obtained in single shot. Please respond asap

[@TechPrimers]

you cannot do that for all microservices in one place. It can be done only at individual service level

[@gmsvgm]

Tech Primers ok Can I read the swagger json from all my services and call it from a single place??

[@melsaied101]

Thank you for you effort

[@neekhilverma9560]

Sir, Please show a example for the integration of swagger and mongoDB in spring framework

[@TechPrimers]

i have separate video on mongo. you can merge them both

[@neekhilverma9560]

@@TechPrimers ok sir I will try to merge them . Thank you 😊

[@irshadb6587]

There is another option of writing the swagger yml file and generate the code from it. Could you elaborate on that too? Thanks

[@TechPrimers]

sure will do

[@nirvanjain3021]

Liked Video Use something different every time other than Hello World It confuses first timers

[@sudinranjitkar5726]

video on spring MVC too please

[@TechPrimers]

here it is: kzbin.info/www/bejne/fJ2se6RvfNF_jdE

[@sudinranjitkar5726]

No no not this one.. I mean REST API Documentation using Swagger2 in Spring MVC.

[@TechPrimers]

it's the same process. instead of loading the swagger configs like we did for spring boot, you need to load it via xml. apart from that, others are same.

[@sudinranjitkar5726]

Oh now i got it. I was having an error of blank page. The swagger-ui used to load but i get blank page. But finally found the error was in the pom.xml i changed the version of spring-core to 4.3.10.RELEASE and everything works fine. Version older then 4.3 gives an error like blank page..

[@TechPrimers]

+Sudeen Ranjitkar cool. Thanks for sharing.

[@chinmaykrovvidi8519]

So you cannot override 200 Message ?

[@yusuffajarulloh4671]

thank you!!!

[@TechPrimers]

Glad it was helpful 👍🏻

[@vidyasagarareddy6118]

@Tech primers, How are you getting the license for free the Intellij, I can see on their site, it is very costly.

[@TechPrimers]

Use Community edition. It's free

[@japantamil]

super sirrr

[@sayitlikeitis1202]

Good videos from this company. Excepting that the BACKGROUND MUSIC is extremely ANNOYING !!! . Tell me is there any other website that explains concepts with movie like background ?

[@rohitkolar5076]

what is the name of that sound you are playing in intro

[@TechPrimers]

Its from Joakim Karud

[@araran5610]

If you have such error : Failed to start bean 'documentationPluginsBootstrapper' try to insert this in your application.properties : spring.mvc.pathmatch.matching-strategy=ant-path-matcher

[@rageshsharma4368]

Awesome video :)

[@dssomething8516]

How we can deploy war file into tomcat. Make a video for it.

[@TechPrimers]

HI DS, there are lots of good videos in KZbin already for that

[@dssomething8516]

Tech Primers thanks for reply I have faced a issue that is resolved :)

[@vipinahuja6096]

Nice video :) .. I have one question -> Can I catch response from swagger and use in my java code. e.g: if I receive successful response Swagger should show some message and give me link do u want to go next request. Thanks in advance :) .

[@TechPrimers]

HI Vipin, Swagger is used only as a documentation tool, we should not use it for controlling workflow using UI. You can get the response and use it in java code, but showing message and giving link for going to next request is an overkill.

[@vipinahuja6096]

+Tech Primers thanks a lot for reply. Got it

[@chrispie5]

@@vipinahuja6096 I think what you looking for is a rest concept called hateoas. Whereby the rest service is giving you a response of the next available options

[@amityadav-bj9no]

Thank you!!

[@anushaanu9619]

I have followed all steps,but I'm getting whitelable error,in chrome,and 404 error in console,please answer this,I'm new to spring boot

[@ILyaCyclone]

This is Spring Boot 1.5.6 video and it is 2.1.* nowadays - a lot could change, e.g. URL of the UI. Check official docs.

[@RISHABHJAIN4]

Can I get this documentation offline, i.e, when my service is not running then also one could read the Docs ??

[@TechPrimers]

you will have to host it somewhere or the other. At max, you can download the html page.

[@nitheshp6566]

getting error regex method in product api method

[@vikashyadav-nr4my]

Thank you very much for this video..could you pls add video on how to add headers in swagger as well.Thanks

[@TechPrimers]

sure Vikash. Will do

[@chakkaravarthik]

@@TechPrimers That would be great!

[@vijaykumar-gq7bm]

@Tech Primers Please Explain how to Solve This Problem...I Tried So Many Solutions From Google,Stackoverflow etc But Still Error Not Fixed... Can You Please Respond Bro Caused by: java.lang.NullPointerException: Cannot invoke "org.springframework.web.servlet.mvc.condition.PatternsRequestCondition.toString()" because the return value of "springfox.documentation.spi.service.contexts.Orderings.patternsCondition(springfox.documentation.RequestHandler)" is null at springfox.documentation.spi.service.contexts.Orderings$8.compare(Orderings.java:112) ~[springfox-spi-2.6.1.jar:null]