ilabs-koa-joi-router-docs

OpenAPI(aka Swagger) API docs generator for koa-joi-router.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
ilabs-koa-joi-router-docs
0.1.104 years ago4 years agoMinified + gzip package size for ilabs-koa-joi-router-docs in KB

Readme

Koa-Joi-Router Docs Generator
This project is based on paul42/joi-router-swagger-docs.
A node module for generating Swagger 2.0 JSON definitions from existing koa-joi-router routes.
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.

Preview

code<em>to</em>docs

Install

# use npm
npm install koa-joi-router-docs --save
# use yarn
yarn add koa-joi-router-docs

Example

Visit example/ folder to see the full example.

API

new SwaggerAPI()

Creates a new SwaggerAPI instance.

swaggerAPI.addJoiRouter(router, options)

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 .routes property).
Options:
  • prefix: Prefix to add to Swagger path (use prefix from JoiRouter if not set)

swaggerAPI.generateSpec(baseSpec, options)

Create a Swagger specification for this API. A base specification should be provided with an info object (containing at least the title and version strings) and any other global descriptions.
Options:
  • defaultResponses: Custom default responses
```js {
200: {
  description: 'Success'
}
} ```
Donation
If you find this project useful, you can buy us a cup of coffee:


Acknowledgements

We are grateful to the authors of existing related projects for their ideas and collaboration:

Contributors

chuyik | :---:| chuyik |