标签:
API
介绍
配置中心提供了开放的接口用于获取应用在某环境下的配置。
规则
应用的配置将从以下途径获取并进行组合:
- 该应用在指定环境下的
公共
和私有
配置 - 所依赖的应用的
公共
配置 - 所依赖的服务的配置
- 根据指定的环境,仅读取指定环境的以上配置
获取方式
配置的获取需要通过调接口的形式来获取,根据需要传的参数又分以下两种途径
在发布配置的钩子内获取
-
请求地址:
/api/apis/config/
-
请求方法:
GET
-
请求参数:
参数名 类型 必填 默认值 示例 说明 apiToken string 是 $SPUG_API_TOKEN 固定值, Spug
内置的全局变量,仅可在发布配置的钩子中引用format string 否 kv json 返回的格式,目前支持 kv
、env
和json
三种格式,分别对应key = value
、key=value
和{"key": "value"}
,其中env
为 v2.3.8 新增noPrefix string 否 1 v2.3.8 新增,默认返回的 key
会增加应用或服务的标示作为前缀来确保不会出现同名的key
造成配置的意外覆盖问题,如果不需要这一特性可以传该参数来禁用这一默认行为 -
使用示例
以下截图即在
应用发布前
中调用了获取配置的接口,将会把该应用该环境下的配置保存在.env
文件中。
独立使用
-
请求地址:
/api/apis/config/
-
请求方法:
GET
-
请求参数:
参数名 类型 必填 默认值 示例 说明 apiKey string 是 JLV8IGO0DhoxcM7I 调用接口的访问凭据,在 Spug
系统管理/系统设置/开放服务设置 中配置,请勿泄露给他人app string 是 order 指定要获取其配置的应用的标识符(创建应用时设置的该标识符,请在应用管理或应用配置页面查看应用的标识符) env string 是 dev 指定获取应用所在环境的标识符(创建环境时设置的该标识符,请在 配置中心/环境管理页面查看环境标识符) format string 否 kv json 返回的格式,目前支持 kv
、env
和json
三种格式,分别对应key = value
、key=value
和{"key": "value"}
,其中env
为 v2.3.8 新增noPrefix string 否 1 v2.3.8 新增,默认返回的 key
会增加应用或服务的标示作为前缀来确保不会出现同名的key
造成配置的意外覆盖问题,如果不需要这一特性可以传该参数来禁用这一默认行为 -
使用示例1
curl "https://demo.spug.cc/api/apis/config/?apiKey=JLV8IGO0DhoxcM7I&app=order&env=test"
输出如下
db_order_database = order db_order_host = 172.26.89.90 db_order_password = 123456 db_order_port = 3306 db_order_username = root order_app_debug = true order_cache_driver = file order_url = http://test-order.internal.com redis_host = 127.0.0.1 redis_password = 123456
-
使用示例2
curl "https://demo.spug.cc/api/apis/config/?apiKey=JLV8IGO0DhoxcM7I&app=order&env=test&noPrefix=1"
输出如下
app_debug = true cache_driver = file database = order host = 127.0.0.1 password = 123456 port = 3306 url = http://test-order.internal.com username = root
说明
可以通过对比发现,在
noPrefix
模式下,服务订单主库
(标识符 db_order)的配置host
和password
被服务Redis服务
(标识符 redis)覆盖了,所以最终的配置意外丢失了2个。
标签: 来源:
本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享; 2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关; 3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关; 4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除; 5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。