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

Поділитися
Вставка
  • Опубліковано 19 гру 2024

КОМЕНТАРІ • 60

  • @ThinkConstructive
    @ThinkConstructive  2 роки тому +7

    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
    @blackjackal9506 2 роки тому +8

    Excellent spring boot tutorial ma’am
    Thank you!

  • @83sendhil
    @83sendhil Рік тому +2

    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?

  • @krish1947
    @krish1947 Рік тому +3

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

  • @gurunadh3661
    @gurunadh3661 9 місяців тому +2

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

  • @jyothsnagangarapu1096
    @jyothsnagangarapu1096 21 день тому

    hi madam thank you so much for this video ,could you please explain how in real time by using specs in swagger we can create microservices

  • @MallikarjunaReddyY
    @MallikarjunaReddyY 7 місяців тому

    Good content with nice explanation, thank you mam

    • @ThinkConstructive
      @ThinkConstructive  4 місяці тому +1

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

  • @shrutisankhe3703
    @shrutisankhe3703 Рік тому +1

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

  • @NgorSeck
    @NgorSeck 2 роки тому +1

    Great, it's very helpfull.
    thanks

  • @imranullah7355
    @imranullah7355 2 роки тому +1

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

    • @ThinkConstructive
      @ThinkConstructive  2 роки тому +2

      I think you are looking for ua-cam.com/video/iBGkJln9BPo/v-deo.html This is the first video of this series and in this all four request methods are created. Playlist link for the series is - ua-cam.com/play/PLcs1FElCmEu121gqGwlQt47d0SqNkzSTK.html
      Hope this helps

  • @amblessed_onwumere
    @amblessed_onwumere 2 роки тому +2

    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
      @ThinkConstructive  2 роки тому +1

      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
      @amblessed_onwumere 2 роки тому

      @@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
      @amblessed_onwumere 2 роки тому

      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
      @_Nguyenan Рік тому

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

    • @bsing1000
      @bsing1000 2 місяці тому

      For spring boot 3.x.x try this
      org.springdoc
      springdoc-openapi-starter-webmvc-ui
      2.2.0

  • @ravikiran0946
    @ravikiran0946 4 місяці тому

    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?

  • @naveenrajukopparthi3046
    @naveenrajukopparthi3046 2 роки тому +2

    Really Thank you Maa

  • @crenshaw4491
    @crenshaw4491 Місяць тому

    How to integrate swagger editor for easier documentation?

  • @千祥-x4w
    @千祥-x4w 2 роки тому +1

    How to customize the implementation of swagger authentication?

    • @ThinkConstructive
      @ThinkConstructive  2 роки тому +1

      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

  • @uvanana.
    @uvanana. 6 місяців тому

    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

  • @DominiqueBello
    @DominiqueBello 2 місяці тому

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

  • @NamrataMalunjkar
    @NamrataMalunjkar 5 місяців тому

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

  • @말랑괄이
    @말랑괄이 11 місяців тому

    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??

  • @swatimishra660
    @swatimishra660 6 місяців тому

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

  • @nareshchaudhary3624
    @nareshchaudhary3624 Рік тому

    Can we do it without api_path_matcher?

  • @unknowninformation827
    @unknowninformation827 Рік тому +1

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

  • @shubhampatil7336
    @shubhampatil7336 2 роки тому +1

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

  • @nawwintphyu1873
    @nawwintphyu1873 3 місяці тому +1

    Thank you so much!

    • @ThinkConstructive
      @ThinkConstructive  3 місяці тому +1

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

  • @DSIS-manishmayank
    @DSIS-manishmayank 3 місяці тому

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

  • @gokulaher2476
    @gokulaher2476 9 місяців тому +1

    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
      @ThinkConstructive  8 місяців тому +2

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

  • @SinghRahul-
    @SinghRahul- 2 роки тому +2

    Waiting for microservices

  • @nagareddy9744
    @nagareddy9744 Рік тому +1

    where is git repo madam

    • @ThinkConstructive
      @ThinkConstructive  Рік тому +1

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

  • @SinghRahul-
    @SinghRahul- 2 роки тому +2

    Thanku ma'am

  • @vanshgoyal-uo5cf
    @vanshgoyal-uo5cf 6 місяців тому

    mam it's not working

  • @manishreddy6039
    @manishreddy6039 9 місяців тому

    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