diff --git a/MediaServer支持的HTTP-API.md b/MediaServer支持的HTTP-API.md index 3935922..f3d6f4a 100644 --- a/MediaServer支持的HTTP-API.md +++ b/MediaServer支持的HTTP-API.md @@ -33,6 +33,41 @@ MediaServer是ZLMediaKit的主进程,目前支持以下http api接口,这些 操作这些api一般需要提供secret参数以便鉴权,如果操作ip是127.0.0.1,那么可以无需鉴权。 +## API返回结果约定 +- HTTP层面统一返回200状态码,body统一为json。 +- body一般为以下样式: +```json +{ + "code" : -1, + "msg" : "失败提示" +} +``` +- code值代码执行结果,目前包含以下类型: +```c++ +typedef enum { + Exception = -400,//代码抛异常 + InvalidArgs = -300,//参数不合法 + SqlFailed = -200,//sql执行失败 + AuthFailed = -100,//鉴权失败 + OtherFailed = -1,//业务代码执行失败, + Success = 0//执行成功 +} ApiErr; +``` + +- 如果执行成功,一般无msg字段。 + +- `code == -1`时代表业务代码执行不成功,更细的原因一般提供`result`字段,例如以下: +```json +{ + "code" : -1, # 代表业务代码执行失败 + "msg" : "can not find the stream", # 失败提示 + "result" : -2 # 业务代码执行失败具体原因 +} +``` + +- 开发者一般只要关注`code`字段和msg字段,如果`code !=0 `时,打印显示`msg`字段即可。 +- `code == 0`时代表完全成功,如果有数据返回,一般提供`data`字段。 + ## API详解 ### 1、`/index/api/getThreadsLoad`