App.Examples_Response.TopResult
演示在返回结果根节点添加额外的字段返回

API URL:https://locator.cleanbox.top/?s=App.Examples_Response.TopResult

Request Method  GET/POST

API Description: 自定义动态返回JSON根节点,增加最外层返回消息,例如最外层的【status 状态码】和【time 当前系统时间】

Download Markdown ApiDoc

API Parameters

Parameter NameTypeIs RequiredDefaultNoteDescription

Response Result

Parameter NameTypeDescription

Error List

Error StatusError Description
400表示客户端参数错误
404表示接口服务不存在
500表示服务端内部错误

Test Online   

ParameterIs RequiredValue
service Required

Client Request Demo


# 【 演示在返回结果根节点添加额外的字段返回】接口文档 v1.0.0
**所属平台**: PhalApi API Framework
**接口地址**: `https://locator.cleanbox.top/?s=App.Examples_Response.TopResult`
**请求方式**: POST

## 接口基本信息
- **功能描述**:  自定义动态返回JSON根节点,增加最外层返回消息,例如最外层的【status 状态码】和【time 当前系统时间】
- **返回格式**: JSON

## 请求参数说明

### 系统参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| s | string | 必填 | 接口服务名,固定为`App.Examples_Response.TopResult` |


### 业务参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|


## 返回字段
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |


## 请求示例
```bash
curl -X POST 'https://locator.cleanbox.top/?s=App.Examples_Response.TopResult' \
  -H 'Content-Type: application/json' \
  -d '[]'
```

返回示例:
```json
{
    "ret": 200,
    "data": {
        "status": "data结构内的status 状态码"
    },
    "msg": "",
    "status": "OK", // 新增的根节点
    "time": 1681744695 // 新增的根节点
}


```
{
    "ret": 200,
    "data": {
        "status": "data结构内的status 状态码"
    },
    "msg": "",
    "status": "OK", // 新增的根节点
    "time": 1681744695 // 新增的根节点
}

Tips: This API Document will be generated automately by PHP code and comments. More detail please visit Docs.