Koa-Joi-Router Docs Generator
This project is based on paul42/joi-router-swagger-docs.
Aiming to be a replacement for koa-resourcer-docs which can take advantage of various Swagger 2.0 tools for generating client libraries, test suites, AWS Lambda/serverless, etc.
# use npmnpm install koa-joi-router-docs --save# use yarnyarn add koa-joi-router-docs
Visit example/ folder to see the full example.
Creates a new SwaggerAPI instance.
Add a joi-router instance to the API. The router should already have all its
routes set up before calling this method (which pulls the route definitions
from the router's
- prefix: Prefix to add to Swagger path (use prefix from JoiRouter if not set)
Create a Swagger specification for this API. A base specification should be
provided with an
info object (containing at least the
strings) and any other global descriptions.
- defaultResponses: Custom default responses200:description: 'Success'
If you find this project useful, you can buy us a cup of coffee:
We are grateful to the authors of existing related projects for their ideas and collaboration: