Java Spring Boot REST API Documentation | What, Why and How of Swagger

[@ThinkConstructive]

API Documentation is essential part of any REST API application. This is Full Course on Swagger Documentation For Java Spring Boot REST API Application. In this tutorial, Need of API documentation, how to automate it using Swagger, then swagger configuration for followed by detailed demonstration using CloudVendorAPI is discussed. Finally, REST API is tested using Postman tool and Swagger UI. Kindly attend full session to understand it completely. Happy learning. Cheers, Esha

[@blackjackal9506]

Excellent spring boot tutorial ma’am Thank you!

[@ThinkConstructive]

Welcome 😊

[@naveenrajukopparthi3046]

Really Thank you Maa

[@ThinkConstructive]

Most Welcome 😊

[@gurunadh3661]

for spring 3 versions springfox is not in usage, instead use springdoc openapi

[@manishreddy6039]

Thank you

[@ranierimichel6826]

Nice, thank you.

[@DominiqueBello]

Thanks for this incredible tutorial. Would it be possible to get an update with Swagger 3? It would be wonderful. Cheers!

[@MallikarjunaReddyY]

Good content with nice explanation, thank you mam

[@ThinkConstructive]

Thank you so much ❤️ Stay connected and please share with others too 😊

[@NgorSeck]

Great, it's very helpfull. thanks

[@ThinkConstructive]

Welcome 😊

[@nawwintphyu1873]

Thank you so much!

[@ThinkConstructive]

Most Welcome 😊 Please stay connected and share channel details with others too, thanks 😊

[@NamrataMalunjkar]

Awesome video @ThinkConstructive One question, If I am using gradle which swagger dependency can I use

[@SinghRahul-]

Thanku ma'am

[@ThinkConstructive]

Welcome 😊

[@ravikiran0946]

How to share the API documentation with consumer application. Also, can we generate the model classes using the API documentation and use in consumer application to build the request?

[@DSIS-manishmayank]

Can you please make a video on jwt token on this project?

[@krish1947]

hi mam !! v3/api-docs this isn't working for me can u help

[@travelwithahmedmurtaza]

Same here, localhost:8080/v3/api-docs shows 404

[@swatimishra660]

not able to check api doc from postman as well as in ui both is not working for me

[@83sendhil]

Mam, Thanks for the course. From my end, i have updated pom.xml and application.yml file but getting v3/api-docs as not found error in postman. Plz share your thoughts. Is there any additional configuration we need to do?

[@lonen3rd]

Same here

[@soumyabandari9630]

same, did you get any solution?

[@SinghRahul-]

Waiting for microservices

[@ThinkConstructive]

Sure, will plan it

[@unknowninformation827]

Mam,pls make a video of how real time application deployment happen in IT. And what are the software used for it and how?

[@ThinkConstructive]

Sure, I will plan a video on this topic.

[@shubhampatil7336]

Mam please make a series on microservice using spring boot ,spring cloud?

[@ThinkConstructive]

Sure

[@gokulaher2476]

Good video with proper content I have one request If possible can you pl.reduce the frequency of the Like subscribe amd bell 🔔 notification pop-up its feeling like disturbing while watching the video Thanks!

[@ThinkConstructive]

Thank you 😊 Sure, will take care of this in upcoming videos. Please stay connected and share with others too.

[@shrutisankhe3703]

Hi Ma'am Ma'am swagger dependency not added in pom.xml they gives error "Dependency io.springfox not found

[@ThinkConstructive]

Hello, Swagger dependency is added please recheck 11:26

[@amblessed_onwumere]

Dear Ma, I am getting "This application has no explicit mapping for /error, so you are seeing this as a fallback." There was an unexpected error (type=Not Found, status=404). No message available. What could be the cause

[@ThinkConstructive]

Hello, Please check the application logs for more details, as this the default error page of Spring Boot for any kind of error. Get the detailed error information from application console logs.

[@amblessed_onwumere]

@@ThinkConstructive org.apache.tomcat.jni.LibraryNotFoundError: Can't load library: C:\Users\okeyb\Documents\Spring Boot\book-rest-demo\bin\tcnative-2.dll, Can't load library: C:\Users\okeyb\Documents\Spring Boot\book-rest-demo\bin\libtcnative-2.dll, Can't load library: C:\Users\okeyb\Documents\Spring Boot\book-rest-demo\bin\tcnative-1.dll, Can't load library: C:\Users\okeyb\Documents\Spring Boot\book-rest-demo\bin\libtcnative-1.dll, no tcnative-2 in java.library.path: C:\Program Files\Java\jdk-17.0.4\bin;C:\WINDOWS\Sun\Java\bin;C:\WINDOWS\system32;C:\WINDOWS;C:\Program Files\Common Files\Oracle\Java\javapath;C:\WINDOWS\system32;C:\WINDOWS;C:\WINDOWS\System32\Wbem;C:\WINDOWS\System32\WindowsPowerShell\v1.0\;C:\WINDOWS\System32\OpenSSH\;C:\Program Files\Git\cmd;C:\Program Files\Java\jdk-17.0.4\bin;C:\maven\apache-maven-3.8.6-bin\apache-maven-3.8.6\bin;c:\mingw64\bin;C:\Program Files odejs\;C:\Program Files\MySQL\MySQL Shell 8.0\bin\;C:\Users\okeyb\AppData\Local\Programs\Python\Python310\Scripts\;C:\Users\okeyb\AppData\Local\Programs\Python\Python310\;C:\Users\okeyb\AppData\Local\Microsoft\WindowsApps;;C:\Users\okeyb\AppData\Local\Programs\Microsoft VS Code\bin;C:\Program Files\heroku\bin;C:\Program Files\JetBrains\IntelliJ IDEA 2022.2.3\bin;;C:\Users\okeyb\AppData\Roaming pm;., no libtcnative-2 in java.library.path: C:\Program Files\Java\jdk-17.0.4\bin;C:\WINDOWS\Sun\Java\bin;C:\WINDOWS\system32;C:\WINDOWS;C:\Program Files\Common Files\Oracle\Java\javapath;C:\WINDOWS\system32;C:\WINDOWS;C:\WINDOWS\System32\Wbem;C:\WINDOWS\System32\WindowsPowerShell\v1.0\;C:\WINDOWS\System32\OpenSSH\;C:\Program Files\Git\cmd;C:\Program Files\Java\jdk-17.0.4\bin;C:\maven\apache-maven-3.8.6-bin\apache-maven-3.8.6\bin;c:\mingw64\bin;C:\Program Files odejs\;C:\Program Files\MySQL\MySQL Shell 8.0\bin\;C:\Users\okeyb\AppData\Local\Programs\Python\Python310\Scripts\;C:\Users\okeyb\AppData\Local\Programs\Python\Python310\;C:\Users\okeyb\AppData\Local\Microsoft\WindowsApps;;C:\Users\okeyb\AppData\Local\Programs\Microsoft VS Code\bin;C:\Program Files\heroku\bin;C:\Program Files\JetBrains\IntelliJ IDEA 2022.2.3\bin;;C:\Users\okeyb\AppData\Roaming pm;., no tcnative-1 in java.library.path: C:\Program Files\Java\jdk-17.0.4\bin;C:\WINDOWS\Sun\Java\bin;C:\WINDOWS\system32;C:\WINDOWS;C:\Program Files\Common Files\Oracle\Java\javapath;C:\WINDOWS\system32;C:\WINDOWS;C:\WINDOWS\System32\Wbem;C:\WINDOWS\System32\WindowsPowerShell\v1.0\;C:\WINDOWS\System32\OpenSSH\;C:\Program Files\Git\cmd;C:\Program Files\Java\jdk-17.0.4\bin;C:\maven\apache-maven-3.8.6-bin\apache-maven-3.8.6\bin;c:\mingw64\bin;C:\Program Files odejs\;C:\Program Files\MySQL\MySQL Shell 8.0\bin\;C:\Users\okeyb\AppData\Local\Programs\Python\Python310\Scripts\;C:\Users\okeyb\AppData\Local\Programs\Python\Python310\;C:\Users\okeyb\AppData\Local\Microsoft\WindowsApps;;C:\Users\okeyb\AppData\Local\Programs\Microsoft VS Code\bin;C:\Program Files\heroku\bin;C:\Program Files\JetBrains\IntelliJ IDEA 2022.2.3\bin;;C:\Users\okeyb\AppData\Roaming pm;., no libtcnative-1 in java.library.path: C:\Program Files\Java\jdk-17.0.4\bin;C:\WINDOWS\Sun\Java\bin;C:\WINDOWS\system32;C:\WINDOWS;C:\Program Files\Common Files\Oracle\Java\javapath;C:\WINDOWS\system32;C:\WINDOWS;C:\WINDOWS\System32\Wbem;C:\WINDOWS\System32\WindowsPowerShell\v1.0\;C:\WINDOWS\System32\OpenSSH\;C:\Program Files\Git\cmd;C:\Program Files\Java\jdk-17.0.4\bin;C:\maven\apache-maven-3.8.6-bin\apache-maven-3.8.6\bin;c:\mingw64\bin;C:\Program Files odejs\;C:\Program Files\MySQL\MySQL Shell 8.0\bin\;C:\Users\okeyb\AppData\Local\Programs\Python\Python310\Scripts\;C:\Users\okeyb\AppData\Local\Programs\Python\Python310\;C:\Users\okeyb\AppData\Local\Microsoft\WindowsApps;;C:\Users\okeyb\AppData\Local\Programs\Microsoft VS Code\bin;C:\Program Files\heroku\bin;C:\Program Files\JetBrains\IntelliJ IDEA 2022.2.3\bin;;C:\Users\okeyb\AppData\Roaming pm;. at org.apache.tomcat.jni.Library.(Library.java:93) ~[tomcat-embed-core-10.1.1.jar:10.1.1] at org.apache.tomcat.jni.Library.initialize(Library.java:148) ~[tomcat-embed-core-10.1.1.jar:10.1.1] at org.apache.catalina.core.AprLifecycleListener.init(AprLifecycleListener.java:200) ~[tomcat-embed-core-10.1.1.jar:10.1.1] at org.apache.catalina.core.AprLifecycleListener.isAprAvailable(AprLifecycleListener.java:112) ~[tomcat-embed-core-10.1.1.jar:10.1.1]

[@amblessed_onwumere]

java.lang.ClassNotFoundException: java.lang.WrongThreadException at java.base/jdk.internal.loader.BuiltinClassLoader.loadClass(BuiltinClassLoader.java:641) ~[na:na] at java.base/jdk.internal.loader.ClassLoaders$AppClassLoader.loadClass(ClassLoaders.java:188) ~[na:na]

[@_Nguyenan]

@@amblessed_onwumere i have the same error with you, can you fix it ?

[@千祥-x4w]

How to customize the implementation of swagger authentication?

[@ThinkConstructive]

More methods needs to be called in Docket bean - .securitySchemes(singletonList(apiKey())) .securityContexts(singletonList(securityContext())) - For more info please refer - springfox.github.io/springfox/docs/current/#docket-spring-java-configuration

[@말랑괄이]

thx for this great vedio!! um...i followed it well.. but in building docket bean, paths is "/cloudvendor/*" right? but, when i run it, in document, there are only GET(by id) and DELETE method in controller.. so i updated the paths to "/cloudvendor". and then run it. but in document, there are only GET(all), POST, PUT method in controller.. so i asked this to chat gpt, gpt taught me to update paths to "/cloudvendor/**" . so i did it, and all methods appear. but it is not good that..right? how can i do?? can you explain how to do it??

[@imranullah7355]

Ma'am, where and how you created the request method? please let me know that how to make a Swagger request method?

[@ThinkConstructive]

I think you are looking for kzbin.info/www/bejne/n3OqnH2io551htE This is the first video of this series and in this all four request methods are created. Playlist link for the series is - kzbin.info/aero/PLcs1FElCmEu121gqGwlQt47d0SqNkzSTK Hope this helps

[@nagareddy9744]

where is git repo madam

[@ThinkConstructive]

github.com/thinkconstructive/rest-api-spring-boot-demo/tree/master

[@uvanana.]

Mam again again am getting white label 404 error why mam , everything is working fine after doing testing its not coming like get post or any method also i don't got any errors in testing i fixed everything and it was working fine, can yu let me know why "timestamp": "2024-05-26T10:34:44.635+00:00", "status": 404, "error": "Not Found", "trace": "org.springframework am getting this error when everything is fine Tried to change the port number, restarting and endpoints checking but nothing works , plz suggest a solution

[@manishreddy6039]

I got struck with getting custom description on swagger UI. @ThinkConstructive can you please help me with it... I tried a lot to get custom info on swagger UI.. I have tried n number changes and configurations , still I am facing the same issue.. can you please help me it would be great help for me to move forward

[@nareshchaudhary3624]

Can we do it without api_path_matcher?

[@vanshgoyal-uo5cf]

mam it's not working