Swagger API documentation tutorial for beginners 2023

Поделиться
HTML-код
  • Опубликовано: 1 окт 2024
  • in this video we’re going to create swagger api doc under 15 minutes ,
    Swagger is a library that allows you to create and consume JSON representations of your web API. This tutorial for beginners will show you how to create a simple Swagger document and use it to generate a JSON representation of your web API.
    If it is valuable to you, you can support skills with arif
    www.buymeacoff...
    If you're new to Swagger, this tutorial is for you! In this video, we'll walk you through the steps necessary to create and consume a simple Swagger document. This document will represent your web API and allow you to generate a JSON representation of it. After watching this video, you'll be able to use Swagger to generate documentation for your web API!
    Github for source code github.com/dev...

Комментарии • 36

  • @ShubhamShukla-e3y
    @ShubhamShukla-e3y Месяц назад

    why you hit api /api-docs/#/ instead of /api-docs

  • @metekaba6532
    @metekaba6532 5 месяцев назад +1

    Hello there. Thank you for the tutorial. Here is a question I want to ask. Based on the most of the resources from the Internet, Swagger is the standard way of documenting the Standard APIs. Yet, you explained it. But where is the document, exactly? On the Swagger webpage, how to create the documentation file? Is the "Response body" is what you mean by saying documentation? Thanks.

  • @bouzairimadeddine5621
    @bouzairimadeddine5621 Год назад +1

    I with u do swagger using YAML file, and how to connect the file with swagger UI

  • @uzomanwanne2751
    @uzomanwanne2751 2 месяца назад

    A great resource to start learning swagger docs. However, the audio quality is poor.

  • @Arif-gf7sn
    @Arif-gf7sn 4 месяца назад

    Hello, first of all great tutorial. I have a question though. When I go to the url, I get a blank page. How do I fix this?

  • @rikperenman6680
    @rikperenman6680 4 месяца назад

    How can i connect my mysql database to the api?

  • @adilboudida3412
    @adilboudida3412 5 месяцев назад +1

    NestJS?

  • @coolrads
    @coolrads 6 месяцев назад

    I have a question, why are we defining two app.use here-
    In line 15 as app.use("/", bookRoutes) and line 18 -app.use("/api-docs", swaggerui.serve, swaggerui.setup(spacs)) 🤔

    • @shivanigupta8831
      @shivanigupta8831 6 месяцев назад

      56z

    • @andersongil8345
      @andersongil8345 6 дней назад

      the first one are the routes of your app (your own endpoints). when you are using swaggerui.server you are defining a second route only for the swaggerui to operate

  • @ranjan_v
    @ranjan_v 7 месяцев назад

    Thank you Arif, this really helps.

  • @GOLDY-em2vy
    @GOLDY-em2vy Месяц назад

    Thank you...its very helpful...

  • @Silwiu
    @Silwiu 11 месяцев назад

    Hi !! How did you moved the explorer bar to the right? :-? interesting

    • @skillswitharif
      @skillswitharif  8 месяцев назад

      You can easily search on Google, one line code

  • @okoyedennis703
    @okoyedennis703 Год назад +1

    Nice video 👍
    i just wish you gave us the YML file

  • @hyphamne
    @hyphamne Год назад

    so it cann't be auto generated right ? In nestJS it is auto generated

  • @kingdavid2446
    @kingdavid2446 Год назад +1

    Great lesson Arif✌

  • @axelbryancasauran5159
    @axelbryancasauran5159 Год назад

    is it possible to implement swagger in an API that is using inheriting a custom basecontroller?

    • @skillswitharif
      @skillswitharif  Год назад

      yes, possible

    • @axelbryancasauran5159
      @axelbryancasauran5159 Год назад

      @@skillswitharif do you have a sample code or github link? because I am having error "Failed to load API definition."

    • @nghiala26
      @nghiala26 Год назад

      ​@@axelbryancasauran5159​​ Hello Axel, you need to change all the methods in your base controller from public to protected.

  • @talday0
    @talday0 8 месяцев назад

    Thank you , it is very useful

  • @the_proletariat
    @the_proletariat Год назад

    Thank you very much for the video ☺

  • @muhammadzahir946
    @muhammadzahir946 Год назад +1

    Good lesson.easy to follow.Thanks man.

  • @YouTubePremium-ww4ct
    @YouTubePremium-ww4ct 6 месяцев назад

    Thank you! Great video keep it up.

  • @carlasgallery
    @carlasgallery 9 месяцев назад

    Thank you a lot, very helpful lesson!