@bangbang93/node-apollo

[![David deps][david-image]][david-url]

node-apollo

携程 Apollo 配置中心 node SDK.

Install

$ npm i node-apollo

Node.js >= 16.0.0 required.

Features

• ✔︎ 适用 eggjs(egg-apollojs), thinkjs 等 docker 部署项目
• ✔︎ 适用自己手动搭建的服务，可直接读取 JSON 格式的配置
• ✔︎ 增加支持 http/https 协议请求

Usage

• See examples

Methods

apollo# remoteConfigServiceFromCache(config)

const config = {
  configServerUrl: 'http://example.com',
  // configServerUrl: 'https://example.com', // Support https
  appId: '<appId>',
  clusterName: 'default',
  namespaceName: ['namespaceName1', 'namespaceName2'], // n1的配置会被n2配置覆盖
  // clientIp: '',
}
const result = await apollo.remoteConfigServiceFromCache(config)

NOTE: 通过带缓存的 Http 接口从 Apollo 读取配置，详情请参考Apollo 开放平台.

apollo# remoteConfigServiceSkipCache(config)

const config = {
  configServerUrl: 'http://example.com',
  // configServerUrl: 'https://example.com', // Support https
  appId: '<appId>',
  clusterName: 'default',
  namespaceName: ['namespaceName1', 'namespaceName2'], // n1的配置会被n2配置覆盖
  // clientIp: '', // optional
  // releaseKey: '', // optional
}
const result = await apollo.remoteConfigServiceSkipCache(config)

NOTE: 通过不带缓存的 Http 接口从 Apollo 读取配置，详情请参考Apollo 开放平台.

apollo# remoteConfigService(config)

const config = {
  configServerUrl: 'http://example.com',
  // configServerUrl: 'https://example.com',  // Support https
  appId: '<appId>',
  clusterName: 'default',
  namespaceName: '', //no surport multi namespace name, optional
  apolloEnv: 'dev',
  token: '<apollo access token>', // required
  // clientIp: '',
}
const result = await apollo.remoteConfigService(config)

NOTE: 读取携程 Apollo 配置，调用第三方应用接入 Apollo 开放平台， 详情请参考Apollo 开放平台.

License

MIT