一个简单的云端公告服务,创建公告的时候key才显示一次,之后就不会显示了,Key和用户的key不同,请注意!
接口地址: https://api.xcvts.cn/api/yungonggao
返回格式: JSON
请求方式: GET/POST/DELETE/PUT
请求示例: https://api.xcvts.cn/api/yungonggao?id=1 调用测试
请求参数说明:
| 名称 | 是否必填 | 类型 | 说明 | 接口测试 |
|---|---|---|---|---|
| action | 是 | string | 默认为'get',创建为'create',更新为'update',删除为'delete' | 调用测试 |
| id | 是 | string | 公告ID标识符 | 调用测试 |
| auth_key | 是 | string | 创建公告时返回的认证密钥(作用:修改公告,删除公告) | 调用测试 |
| content | 是 | string | 公告内容 | 调用测试 |
| updated_by | 否 | string | 更新者标识,默认为"system" | 调用测试 |
返回参数说明:
| 名称 | 类型 | 说明 |
|---|
返回示例:
{
"status": "success",
"code": 200,
"message": "请求成功",
"timestamp": "2025-09-27 21:46:13",
"data": {
"id": "1",
"content": "小尘yyds",
"created_at": "2025-09-27 21:35:58",
"updated_at": "2025-09-27 21:45:55"
}
}
请求参数设置:
| 参数名称 | 参数值 |
|---|---|
{
"status": "success",
"code": 200,
"message": "请求成功",
"timestamp": "2025-09-27 21:46:13",
"data": {
"id": "1",
"content": "小尘yyds",
"created_at": "2025-09-27 21:35:58",
"updated_at": "2025-09-27 21:45:55"
}
}
错误码格式说明:
| 名称 | 类型 | 说明 |
|---|
代码示例:
获取公告 (GET/POST)
参数名 类型 是否必需 说明
id string 是 公告ID标识符
action string 否 操作类型,默认为"get"
创建公告 (POST/PUT)
参数名 类型 是否必需 说明
action string 是 必须设置为"create"
id string 是 公告ID标识符(唯一)
content string 是 公告内容
created_by string 否 创建者标识,默认为"system"
更新公告 (POST/PUT)
参数名 类型 是否必需 说明
action string 是 必须设置为"update"
id string 是 要更新的公告ID
auth_key string 是 创建公告时返回的认证密钥
content string 是 新的公告内容
updated_by string 否 更新者标识,默认为"system"
删除公告 (POST/DELETE)
参数名 类型 是否必需 说明
action string 是 必须设置为"delete"
id string 是 要删除的公告ID
auth_key string 是 创建公告时返回的认证密钥
deleted_by string 否 删除者标识,默认为"system"