AgileConfig - RESTful API 介紹

AgileConfig

AgileConfig是一個基於.net core開發的輕量級配置中心。
AgileConfig秉承輕量化的特點，部署簡單、配置簡單、使用簡單、學習簡單，它只提取了必要的一些功能，並沒有像Apollo那樣復雜且龐大。但是它的功能也已經足夠你替換webconfig，appsettings.json這些文件了。如果你不想用微服務全家桶，不想為了部署一個配置中心而需要看N篇教程跟幾台服務器那么你可以試試AgileConfig ：）

RESTful Api

為了更加方便的跟業務系統集成最新版的AgileConfig已支持json格式的 restful api來維護配置 。
本API入參跟出參為json格式，所以請求的時候需設置Content-Type頭部為application/json 。
使用basic簡單認證，設置Authorization頭部為Basic base64(userName:password) 。
當操作節點、應用api的時候basic認證的userName固定設置為admin，password為當前密碼 。
當操作配置api的時候basic認證的userName為應用的appid，password為應用的秘鑰 。

節點

因為本系統登錄的時候沒有用戶名所以basic認證的時候用戶名固定使用admin密碼為當前設置的密碼

model

    {
        "address": "http://localhost:5000",
        "remark": "this",
        "status": 0, // 1=online 0=offile
        "lastEchoTime": null
    }

獲取所有節點

參數名	值
url	/api/node
method	GET
status code	200
response content	[model]

添加節點

參數名	值
url	/api/node
method	POST
status code	201
request body	model
response content	空

刪除節點

參數名	值
url	/api/node?address={address}
method	DELETE
status code	204
response content	空

應用

因為本系統登錄的時候沒有用戶名所以basic認證的時候用戶名固定使用admin密碼為當前設置的密碼

model

   {
        "id": "xxx",
        "name": "測試程序3",
        "secret": "",
        "enabled": true, //是否啟用
        "inheritanced": true, //是否可以繼承
        "inheritancedApps": null //繼承的app列表
    }

獲取所有應用

參數名	值
url	/api/app
method	GET
status code	200
response content	[model]

獲取單一應用

參數名	值
url	/api/app/{appid}
method	GET
status code	200
response content	model

添加應用

參數名	值
url	/api/app
method	POST
status code	201
request body	model
response content	空

修改應用

參數名	值
url	/api/app
method	PUT
status code	200
request body	model
response content	空

配置

配置的basic認證用戶名使用appId密碼使用secret

model

    {
        "id": "0986e7ed33c447618f28e92360394cea",
        "appId": "xxx",
        "group": "", //組
        "key": "key1", 
        "value": "3333",
        "description": null, //描述
        "onlineStatus": 0, //是否在線 0=等待上線 1=在線
        "status": 1 // 0=刪除 1=正常
    }

獲取所有app的配置

參數名	值
url	/api/config
method	GET
status code	200
response content	[model]

獲取單一配置

參數名	值
url	/api/config/{id}
method	GET
status code	200
response content	model

新建配置

參數名	值
url	/api/config
method	POST
status code	201
request body	model
response content	空

修改配置

參數名	值
url	/api/config
method	PUT
status code	200
request body	model
response content	空

刪除配置

參數名	值
url	/api/config/{id}
method	DELETE
status code	204
response content	空

上線配置

參數名	值
url	/api/config/publish/{id}
method	POST
status code	200
response content	空

下線配置

參數名	值
url	/api/config/offline/{id}
method	POST
status code	200
response content	空

相關內容：
AgileConfig-如何使用AgileConfig.Client讀取配置
AgileConfig-輕量級配置中心 1.1.0 發布，支持應用間配置繼承
造輪子-AgileConfig基於.NetCore的一個輕量級配置中心
gihub地址：
AgileConfig
AgileConfig.Client