API 管理系统概览
👤
用户模块
登录/信息/资料修改
📝
订单模块
列表查询/详情查看
🔧
调试工具
模拟请求/响应测试
📊
文档导出
导出为Markdown/PDF
本系统为纯前端 API 文档展示工具，支持多模块接口管理、响应式布局适配。
点击上方快捷卡片可直接进入对应接口文档，也可通过「接口文档」导航栏查看完整列表。
点击上方快捷卡片可直接进入对应接口文档，也可通过「接口文档」导航栏查看完整列表。
接口基础信息
基础域名：https://api.example.com/v1
请求头：需携带 Authorization: Bearer {token}（登录接口除外）
响应格式：统一返回 JSON 格式，code=200 代表请求成功
POST
用户登录 - /user/login
接口描述
请求参数
响应示例
用户通过账号密码登录，获取访问令牌
是否需要 Token：否
请求超时：30s
| 参数名 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| username | String | 是 | 用户账号 |
| password | String | 是 | 用户密码（MD5 加密） |
{
"code": 200,
"msg": "登录成功",
"data": {
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"expire_time": "2025-12-31 23:59:59",
"user_id": 1001
}
}
GET
获取用户信息 - /user/info
接口描述
请求参数
响应示例
根据 Token 获取当前登录用户的基本信息
是否需要 Token：是
| 参数名 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| user_id | Int | 是 | 用户ID |
{
"code": 200,
"msg": "success",
"data": {
"user_id": 1001,
"username": "test_user",
"nickname": "测试用户",
"avatar": "https://example.com/avatar.jpg"
}
}
PUT
修改用户资料 - /user/edit
接口描述
响应示例
修改当前登录用户的昵称、头像等信息
是否需要 Token：是
{
"code": 200,
"msg": "修改成功",
"data": null
}
GET
订单列表查询 - /order/list
接口描述
响应示例
分页查询当前用户的订单列表
是否需要 Token：是
{
"code": 200,
"msg": "success",
"data": {
"list": [{"order_id": "ORD1001", "amount": 99.00, "status": 1}],
"total": 50,
"page": 1,
"limit": 10
}
}
GET
订单详情 - /order/detail
接口描述
响应示例
根据订单ID查询订单详细信息
是否需要 Token：是
{
"code": 200,
"msg": "success",
"data": {
"order_id": "ORD1001",
"goods_name": "测试商品",
"amount": 99.00,
"create_time": "2025-01-01 10:00:00",
"status": 1
}
}