A Swagger API Docs generator from koa-joi-router routes.
Branch: master
Clone or download
Latest commit 2950dc9 Dec 12, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example Add support for validate.params (#7) Dec 12, 2017
lib Add support for validate.params (#7) Dec 12, 2017
test add: respect prefix in JoiRouter Oct 9, 2017
.eslintignore adding eslint May 1, 2017
.eslintrc.js add: simple test Jun 13, 2017
.gitignore
.travis.yml First pass Aug 28, 2016
LICENSE
README.md add: respect prefix in JoiRouter Oct 9, 2017
index.js Second pass; add documentation Nov 22, 2016
package.json v0.1.9 Dec 12, 2017
yarn.lock update: use o2team-joi-to-swagger Nov 28, 2017

README.md

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_to_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
    {
      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