后台接口文档示例

# ****项目后台API接口文档(比代码重要)

### API-V1 接口说明

* 接口地址：http://hai.com/v1
* 服务器已经全部开启CORS跨域支持
* 使用HTTP Status Code为状态标识
*  数据返回格式统一使用json格式 



### 支持的请求方法

* GET(select) 从服务器获取资源
* POST(create):在服务器创建资源
* PUT(update):更新服务器资源
* DELTE(delete):删除服务器资源



### 返回状态码说明

| 状态码 | 含义      | 说明           |
| ------ | --------- | -------------- |
| 200    | OK        | 请求成功       |
| 201    | create    | 创建成功       |
| 404    | not found | 请求资源不存在 |



### 获取用户列表

* 请求路径：/index
* 请求方法：GET
* 请求参数：空



响应示例：

| 参数名 | 参数说明 | 备注 |
| ------ | -------- | ---- |
| id     | 用户id   |      |
| name   | 姓名     |      |
| nengli | 能力     |      |
| jituan | 集团     |      |

```json
{
    "meta": {
        "status": 200,
        "msg": "Ok"
    },
    "data": [
        {
            "id": 1,
            "name": "飞",
            "nengli": "果实",
            "jituan": "草团",
            "img": ""
        },
        {
            "id": 2,
            "name": "孙",
            "nengli": "反馈",
            "jituan": "非常好",
            "img": ""
        }
    ]
}

获取单个用户信息

• 请求路径： /getone/:id
• 请求方法：GET
• 请求参数：

参数	说明	是否为空
id	用户id	否

响应示例：

参数名	参数说明	备注
id	用户id
name	姓名
nengli	能力
jutuan	集团

{
    "meta": {
        "status": 200,
        "msg": "ok"
    },
    "data": {
        "id": 3,
        "name": "dd",
        "nengli": "花实",
        "jituan": "草团",
        "img": ""
    }
}

修改用户数据

• 请求路径：/edit/:id

• 请求方法：put

• 请求参数：

  参数	说明	是否为空
  id	用户id	N
  name	用户姓名	Y
  nengli	能力	Y
  jituan	集团	Y

响应示例

参数	参数说明	备注
data	受影响行数

{
    "meta": {
        "status": 200,
        "msg": "ok"
    },
    "data": 1
}