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...
why you hit api /api-docs/#/ instead of /api-docs
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.
Waiting for a response too
@@martinmtawali7359 waiting for response too😁
I with u do swagger using YAML file, and how to connect the file with swagger UI
A great resource to start learning swagger docs. However, the audio quality is poor.
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?
How can i connect my mysql database to the api?
NestJS?
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)) 🤔
56z
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
Thank you Arif, this really helps.
Thanks
Thank you...its very helpful...
Hi !! How did you moved the explorer bar to the right? :-? interesting
You can easily search on Google, one line code
Nice video 👍
i just wish you gave us the YML file
In the description, update
so it cann't be auto generated right ? In nestJS it is auto generated
Great lesson Arif✌
is it possible to implement swagger in an API that is using inheriting a custom basecontroller?
yes, possible
@@skillswitharif do you have a sample code or github link? because I am having error "Failed to load API definition."
@@axelbryancasauran5159 Hello Axel, you need to change all the methods in your base controller from public to protected.
Thank you , it is very useful
Glad it was helpful!
Thank you very much for the video ☺
Good lesson.easy to follow.Thanks man.
Glad it was helpful!
Thank you! Great video keep it up.
Thanks, will do!
Thank you a lot, very helpful lesson!
My pleasure 😍