后台接口文档示例

后台接口文档示例项目后台 API 接口文档 比代码重要 API V1 接口说明 接口地址 http hai com v1 服务器已经全部开启 CORS 跨域支持 使用 HTTPStatusCo 为状态标识 数据返回格式统一使用 json 格式支持的请求方法 GET select 从服务器获取资源 POST create 在服务器创建资源 PUT update 更新服务器资源 DELTE delete 删除服务器资源返回状态码

# 项目后台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 } public function get_care_type_list(){ $rs_data = Db::name('care_type') ->where('type_status',0) ->order('type_sort asc,type_id asc') ->field('type_id,type_name') ->select(); //返回提示信息 return ['code'=>1,'data'=>$rs_data]; } 
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。

发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/225769.html原文链接:https://javaforall.net

(0)
上一篇 2026年3月17日 上午8:35
下一篇 2026年3月17日 上午8:35


相关推荐

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

关注全栈程序员社区公众号