API接口文档

接口信息

接口地址

https://api.ihuahui.win/api/1.php

请求方式

GET POST

返回格式

JSON

编码格式

UTF-8

功能说明

该接口提供通用数据交互功能,支持通过不同参数组合实现数据查询、提交和处理操作。适用于各类需要与后端进行数据交互的场景,如表单提交、数据列表获取等。

接口采用RESTful设计风格,通过不同的参数组合实现多样化功能,所有响应均采用统一的JSON格式封装。

请求参数

支持以下URL参数(GET)或表单参数(POST):

参数名 类型 是否必填 示例值 说明
action string "getList" 操作类型,指定接口功能(如getList获取列表,submit提交数据)
id int 123 数据ID,用于查询或操作指定数据
page int 1 分页页码,默认1
limit int 10 每页条数,默认10,最大50
keyword string "test" 搜索关键词,用于模糊查询

响应格式

成功响应 (200)

{
  "code": 200,
  "msg": "操作成功",
  "data": {
    "total": 100,  // 总条数(分页时返回)
    "list": [
      {
        "id": 1,
        "name": "示例数据1",
        "create_time": "2023-01-01 12:00:00"
      },
      // 更多数据...
    ]
  }
}

错误响应

{
  "code": 400,
  "msg": "参数错误,请检查请求参数",
  "data": null
}

响应字段说明

字段名 类型 说明
code int 状态码(200表示成功,其他表示失败)
msg string 操作结果描述信息
data object/array 业务数据,成功时返回具体内容,失败时为null

示例调用

1. 获取列表数据

请求地址

https://api.ihuahui.win/api/1.php?action=getList&page=1&limit=10

响应结果

{
  "code": 200,
  "msg": "查询成功",
  "data": {
    "total": 56,
    "list": [
      {"id": 1, "title": "文章标题1"},
      {"id": 2, "title": "文章标题2"}
    ]
  }
}

2. 获取单条数据

请求地址

https://api.ihuahui.win/api/1.php?action=getItem&id=123

响应结果

{
  "code": 200,
  "msg": "查询成功",
  "data": {
    "id": 123,
    "title": "详细内容标题",
    "content": "这是具体内容...",
    "create_time": "2023-06-15 09:30:00"
  }
}

错误码说明

错误码 说明 解决方案
200 操作成功 -
400 参数错误 检查请求参数是否完整或格式是否正确
404 资源不存在 确认请求的ID或资源路径是否正确
429 请求频率过高 降低请求频率,建议每秒不超过5次
500 服务器内部错误 稍后重试,或联系管理员

在线测试

点击上方按钮发送请求...