Mirror/ZLMediaKit
1
0
Fork 0
mirror of https://github.com/ZLMediaKit/ZLMediaKit.git synced 2026-07-08 23:10:04 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated MediaServer支持的HTTP API (markdown)

夏楚
2020-04-15 22:44:40 +08:00
parent e81c63f48a
commit 8cef9dfec8
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
MediaServer支持的HTTP-API.md

@@ -42,7 +42,7 @@ MediaServer是ZLMediaKit的主进程，目前支持以下http api接口，这些
"msg" : "失败提示" "msg" : "失败提示"
} }
``` ```
- code值代码执行结果，目前包含以下类型： - code值代表执行结果，目前包含以下类型：
```c++ ```c++
typedef enum { typedef enum {
Exception = -400,//代码抛异常 Exception = -400,//代码抛异常
@@ -54,7 +54,7 @@ typedef enum {
} ApiErr; } ApiErr;
``` ```
- 如果执行成功，一般无msg字段。 - 如果执行成功，那么 `code == 0`,并且一般无`msg`字段。
- `code == -1`时代表业务代码执行不成功，更细的原因一般提供`result`字段，例如以下： - `code == -1`时代表业务代码执行不成功，更细的原因一般提供`result`字段，例如以下：
```json ```json
@@ -66,6 +66,7 @@ typedef enum {
``` ```
- 开发者一般只要关注`code`字段和msg字段，如果`code !=0 `时，打印显示`msg`字段即可。 - 开发者一般只要关注`code`字段和msg字段，如果`code !=0 `时，打印显示`msg`字段即可。
- `code == 0`时代表完全成功，如果有数据返回，一般提供`data`字段。 - `code == 0`时代表完全成功，如果有数据返回，一般提供`data`字段。
## API详解 ## API详解