0.0.1 • Published 5 years ago

koa-api-explorer v0.0.1

Weekly downloads
2
License
MIT
Repository
github
Last release
5 years ago

Koa API Explorer

Generate OpenAPI 3 documentation from JSDoc comments. Also includes a swagger UI server.

koa-router + JSDoc => Swagger documentation

TODO: include image representation

Requirements

  • requires node v7.6.0 or higher for ES2015 and async function support

Installation

Run the npm install command:

npm i --save koa-api-explorer

After installing you can include it in your code:

TODO

Example

TODO: example zip to download TODO: example code

Documentation

TODO