API 文档
服务名称 | 版本:1.0.0 | Base URL:
https://api.example.com/v1
认证方式
所有 API 请求需要在 Header 中携带认证信息:
Authorization: Bearer <your_token>通用响应格式
成功响应
json
{
"code": 0,
"message": "success",
"data": {}
}错误响应
json
{
"code": 10001,
"message": "参数错误:name 不能为空",
"data": null
}错误码
| 错误码 | 说明 |
|---|---|
| 0 | 成功 |
| 10001 | 参数错误 |
| 10002 | 未登录 |
| 10003 | 无权限 |
| 10004 | 资源不存在 |
| 50000 | 服务器内部错误 |
接口列表
1. 用户登录
POST /auth/login请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| username | string | 是 | 用户名 |
| password | string | 是 | 密码(至少 6 位) |
请求示例
json
{
"username": "admin",
"password": "123456"
}响应示例
json
{
"code": 0,
"message": "success",
"data": {
"token": "eyJhbGciOiJIUzI1NiIs...",
"expires_in": 7200
}
}2. 获取用户信息
GET /users/:id路径参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | string | 是 | 用户 ID |
响应示例
json
{
"code": 0,
"message": "success",
"data": {
"id": "1",
"name": "张三",
"email": "zhangsan@example.com",
"avatar": "https://cdn.example.com/avatars/1.jpg",
"created_at": "2024-01-01T00:00:00Z"
}
}3. 创建资源
POST /resources请求参数
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| title | string | 是 | — | 标题,1-100 字符 |
| content | string | 是 | — | 内容 |
| status | string | 否 | "draft" | 状态:draft / published |
| tags | string[] | 否 | [] | 标签列表 |
请求示例
json
{
"title": "Hello World",
"content": "这是我的第一篇文章。",
"status": "published",
"tags": ["入门", "教程"]
}响应示例
json
{
"code": 0,
"message": "success",
"data": {
"id": "42",
"title": "Hello World",
"status": "published",
"created_at": "2024-06-15T10:30:00Z"
}
}