API 模板

## 【API 接口名称】
### 1 请求
#### **1.1 请求说明**
* 请求地址：`http://localhost/api/readme.jsp`
* 请求方法使用 **`POST`**
   要注意的是请求某列表的第几页，也必须使用 `POST` 的方式将需要的参数如 _第几页（`page`）_、_每页显示多少条数据（`size`）_ 等放到请求题（`body`）中
* 该请求需要身份验证
* 所有请求和响应的编码均为 UTF-8

#### **1.2 请求参数**

|参数名|数据类型|是否必填|说明|
|-----|-----|-----|-----|
|**`auth`**|字符串|_必填_|用户认证Token|
|**`user_id`**|数字|否|要查询的用户 ID，默认返回当前用户的|

#### **1.3 请求示例**
**CURL**

```bash
curl -X POST {{HOST}}api/User/get?auth=f47ccff1e42f320b32e903fe473c79c0
```


### 2 响应
#### **2.1 响应说明**
1. 响应结果类型为 `application/json-rpc` 或 `application/json`

2. 响应结果基本遵循 json-rpc 2.0 标准
   * 成功时根节点包含 **`result`** 及其预期数据（`data`节点）；
   * 失败时json使用 **`error`** 替代 `result` 节点，且 `error` 中的  `code` 为负数。

#### **2.2 响应参数**
_略_
#### **2.3 响应示例**

**成功的示例：**

```json
{
    "id": "user_detail_5d8cb83a6d62b",
    "jsonrpc":"2.0",
    "result": {
        "code": 200,
        "data": {
            "uname": "Zhang San",
            "age": 27
        },
        "msg": "SUCCESS"
    }
}
```

**失败的示例：**

```json
{
    "id": "user_detail_5d8cb83a6d62b",
    "code": -999,
    "error: "未知服务器异常",
    "jsonrpc": "2.0"
}

``` 

#### **2.4 错误码**
_略_

### 3 其他说明
_无_

----

>>>>>>>>>>>>>>>>>>>>>>>>>预览<<<<<<<<<<<<<<<<<<<<<<<<<<<

【API 接口名称】

1 请求

1.1 请求说明

• 请求地址：http://localhost/api/readme.jsp
• 请求方法使用 POST
  要注意的是请求某列表的第几页，也必须使用 POST 的方式将需要的参数如 第几页（page）、每页显示多少条数据（size） 等放到请求题（body）中
• 该请求需要身份验证
• 所有请求和响应的编码均为 UTF-8

1.2 请求参数

1.3 请求示例

CURL

curl -X POST {{HOST}}api/User/get?auth=f47ccff1e42f320b32e903fe473c79c0

2 响应

2.1 响应说明

1. 响应结果类型为 application/json-rpc 或 application/json

2. 响应结果基本遵循 json-rpc 2.0 标准
   • 成功时根节点包含 result 及其预期数据（data节点）；
   • 失败时json使用 error 替代 result 节点，且 error 中的 code 为负数。

2.2 响应参数

略

2.3 响应示例

成功的示例：

{
    "id": "user_detail_5d8cb83a6d62b",
    "jsonrpc":"2.0",
    "result": {
        "code": 200,
        "data": {
            "uname": "Zhang San",
            "age": 27
        },
        "msg": "SUCCESS"
    }
}

失败的示例：

{
    "id": "user_detail_5d8cb83a6d62b",
    "code": -999,
    "error: "未知服务器异常",
    "jsonrpc": "2.0"
}

2.4 错误码

略

3 其他说明

无

API 模板

原文：https://www.cnblogs.com/systemd/p/12392517.html