resonatecoop / koa-swagger-api-template

Koa Swagger API template

🛠 Status: Maintenance Mode | Stable

This project is currently in maintenance mode - users should feel free to continue to use this app and expect bug fixes, but not expect many additional features.

Koa swagger api template

Stack

• Koa
• Koa grant
• Swagger ui
• Sequelize
• Redis (cache)

Installation

npm install

Build (babel)

npm run build

Env

cp .env.example .env

Development

npm run dev

Testing

npm test

Db connection

Multiple db connections (mysql, postgres) are supported with sequelize. Config is at src/config/databases.js.

Connect to OAuth2 server using koa grant

This API can connect to an OAuth2 server like resonatecoop/id. Config is at src/config/grant.js.

LICENSE

MIT