Skip to content

waytrade/microservice-core

Repository files navigation

@waytrade/microservice-core

GitHub package.json version Language grade: JavaScript Test and Publish NPM Test Report Core Coverage

Publish Docker Images


Core-library for microservice implementations.

We use this library as core of our microservice Apps and it is OSS so you don't need to write it again. No questions will be answered, no support will be given, no feature-request will be accepted. Use it - or fork it and roll your own :)

See https://github.com/waytrade/ib-api-service for an App that uses it.

Provides:

  • An App base-class, that handles server, services and controllers start and stop.
  • A HTTP/REST and WebSocket Server on uWebsocket.
  • Decorators (@get, @post, ..) to route HTTP requested into your controllers
  • An OpenAPI Generator to create an openapi.json for your service App.
  • A SwaggerUI on /index.html to browse and test your REST API.
  • Decorators {@summary, @model, @attribute, ..} to describe your interfaces and model for the OpenApi Generator.

Preparation

$ yarn global add @openapitools/openapi-generator-cli

Usage

$ yarn add @waytrade/microservice-core

update:

$ yarn upgrade @waytrade/microservice-core@^