-
-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Amish Faldu edited this page Sep 27, 2022
·
4 revisions
Swagger-Docs is a node.js library for easily generating swagger api docs with minimal code and setup. This library gives you freedom from generating and maintaining documentation for the APIs endpoints manually and frees you from hassle of update the docs when API changes. It generates and track changes of APIs and reflect them in the UI. This helps you save time, money and productive energy on more innovative tasks and challenging problems
NOTE - Currently this library supports web apps built using express.js. We will be adding support for other web frameworks like Fastify, any contribution related to this will be highly appreciated
-
- SwaggerConfig
- SwaggerDocs
-
- Controller
- RouteMiddleware
-
-
- PathParam
- QueryParam
- Header
- Body
- Request
- Response
- Next
- File
-
- Get
- Put
- Post
- Delete
- Options
- Head
- Patch
- Trace
-
- RouteResponseBody
- RouteRequestBody
- RouteTag
- RouteSummary
- RouteDescription
- RouteExternalDocs
- RouteDeprecated
- RouteSecurity
- RouteServers
-
-
- IsArray
- IsBoolean
- IsNumber
- IsObject
- IsString
- IsEnum