配置管理

接口列表

方法	路径	说明
POST	/configs	创建配置
GET	/configs	获取配置列表
PUT	/configs/{key}	更新配置
DELETE	/configs/{key}	删除配置
GET	/configs/{key}	获取单个配置详情

POST /configs

创建配置

创建一个新的配置

需要认证

此接口需要 Bearer Token 认证

请求体

配置信息

类型： CreateConfigRequest

字段	类型	必填	说明
key	string	是	配置键 示例: "music_path"
value	string	是	配置值（JSON 格式） 示例: "{\"path\":\"/music\"}"

响应

201 - 创建成功

类型： Config

字段	类型	必填	说明
id	integer	否	配置ID 示例: 1
key	string	否	配置键 示例: "music_path"
updated_at	string	否	更新时间 示例: "2024-01-01T12:00:00Z"
value	string	否	配置值（JSON格式） 示例: "{\"path\":\"/music\"}"

400 - 请求数据错误

类型： map[string]string

500 - 创建失败

类型： map[string]string

内容类型

• 请求： application/json
• 响应： application/json

---

GET /configs

获取配置列表

获取配置列表，支持关键词搜索和分页

需要认证

此接口需要 Bearer Token 认证

查询参数

参数	类型	必填	说明
keyword	string	否	搜索关键词
limit	integer	否	每页数量 默认: 20
offset	integer	否	偏移量 默认: 0

响应

200 - 成功返回配置列表

类型： map[string]any

500 - 服务器错误

类型： map[string]string

内容类型

• 请求： application/json
• 响应： application/json

---

PUT /configs/{key}

更新配置

更新配置信息

需要认证

此接口需要 Bearer Token 认证

路径参数

参数	类型	必填	说明
key	string	是	配置键

请求体

配置信息

类型： UpdateConfigRequest

字段	类型	必填	说明
value	string	是	配置值（JSON 格式） 示例: "{\"path\":\"/new_music\"}"

响应

200 - 更新成功

类型： Config

字段	类型	必填	说明
id	integer	否	配置ID 示例: 1
key	string	否	配置键 示例: "music_path"
updated_at	string	否	更新时间 示例: "2024-01-01T12:00:00Z"
value	string	否	配置值（JSON格式） 示例: "{\"path\":\"/music\"}"

400 - 请求数据错误

类型： map[string]string

404 - 配置不存在

类型： map[string]string

内容类型

• 请求： application/json
• 响应： application/json

---

DELETE /configs/{key}

删除配置

根据配置键删除配置

需要认证

此接口需要 Bearer Token 认证

路径参数

参数	类型	必填	说明
key	string	是	配置键

响应

200 - 删除成功

类型： map[string]string

400 - 无效的配置键

类型： map[string]string

500 - 删除失败

类型： map[string]string

内容类型

• 请求： application/json
• 响应： application/json

---

GET /configs/{key}

获取单个配置详情

根据配置键获取详细信息

需要认证

此接口需要 Bearer Token 认证

路径参数

参数	类型	必填	说明
key	string	是	配置键

响应

200 - 成功返回配置详情

类型： Config

字段	类型	必填	说明
id	integer	否	配置ID 示例: 1
key	string	否	配置键 示例: "music_path"
updated_at	string	否	更新时间 示例: "2024-01-01T12:00:00Z"
value	string	否	配置值（JSON格式） 示例: "{\"path\":\"/music\"}"

404 - 配置不存在

类型： map[string]string

内容类型

• 请求： application/json
• 响应： application/json

---