0.0.4 • Published 5 years ago

octodocs v0.0.4

Weekly downloads
2
License
Apache-2.0
Repository
github
Last release
5 years ago

octodocs

Агрегатор OpenAPI документации для микросервисов.

Installation

  npm install -g octodocs

or

  yarn global add octodocs

Usage

  Usage: octodocs --config <config.json>

      <config.json> — path to your config.json file
      --port        — specify port, default 3000
      --help, --h   — show this message
  $ octodocs --config config.json

Config.json

полетипобязательностьописание
urlstringдастартовый урл для опроса сервисов: ${url}/${serviceID}/openapi
discovery"map" \| "k8s" \| "http"датип поиска списка сервисов
servicesmap<string, string \| null>для discovery: "map"работа с заданным списком сервисов, значение параметра объект вида: { "serviceID1": "Service Name", "serviceID2": null }
k8sсм. k8sдля discovery: "k8s"обнаружение списка сервисов через k8s
servicestringдля discovery: "http"загрузка списка сервисов из другого сервиса, значения параметра это урл, ожидаемый ответ от сервиса это json: { services: { id: string, name: string }[] }
@kubernetes/client-nodeaxiosdotenvhttp-proxymicromicro-routeserve-handler
@everything-registry/sub-chunk-2368@zalastax/nolb-oct@infinitebrahmanuniverse/nolb-oct
0.0.4

5 years ago

0.0.3

5 years ago

0.0.2

5 years ago

0.0.1

5 years ago