From ee73f4e8eec151a4ada5ad601ab4b06b58ac0942 Mon Sep 17 00:00:00 2001 From: "haibo.chen" <495810242@qq.com> Date: Wed, 5 Mar 2025 11:12:20 +0800 Subject: [PATCH] Add API documentation structure to README --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 61a4a80..9270faf 100644 --- a/README.md +++ b/README.md @@ -71,8 +71,27 @@ sequenceDiagram 10. SRS-SIP通过设备停止推流 +## API 接口 +- 请求与响应数据格式为JSON +- 所有响应的统一结构为: +```json +{ + "code": 0, + "data": {} +} +``` +错误响应示例: +``` +{ + "code": 500, + "data": { + "msg": "error message" + } +} +``` +### 接口列表 - +暂无,请参考demo。