项目管理接口
项目的增删改查接口,所有接口(除查询外)需要 JWT 认证。
接口列表
| 方法 | 路径 | 说明 | 认证 |
GET | /api/v1/projects | 分页查询项目 | 是 |
GET | /api/v1/projects/all | 获取所有项目 | 是 |
POST | /api/v1/projects | 创建项目 | 是 |
GET | /api/v1/projects/:id | 获取项目详情 | 是 |
PUT | /api/v1/projects/:id | 更新项目 | 是 |
DELETE | /api/v1/projects/:id | 删除项目 | 是 |
分页查询项目
查询参数
| 参数 | 类型 | 默认值 | 说明 |
page | int | 1 | 页码 |
page_size | int | 20 | 每页条数 |
keyword | string | - | 搜索关键词 |
响应示例
{
"code": 200,
"message": "success",
"data": {
"list": [
{
"id": 1,
"name": "软件下载",
"prefix": "soft",
"description": "软件分发项目",
"created_at": "2025-01-01T00:00:00Z",
"updated_at": "2025-01-01T00:00:00Z"
}
],
"total": 1,
"page": 1,
"page_size": 20
}
}
创建项目
请求参数
| 字段 | 类型 | 必填 | 说明 |
name | string | 是 | 项目名称 |
prefix | string | 是 | 项目前缀(URL 路径标识) |
description | string | 否 | 项目描述 |
请求示例
POST /api/v1/projects
Authorization: Bearer <token>
Content-Type: application/json
{
"name": "软件下载",
"prefix": "soft",
"description": "软件分发项目"
}
更新项目
请求参数
| 字段 | 类型 | 必填 | 说明 |
name | string | 是 | 项目名称 |
prefix | string | 是 | 项目前缀 |
description | string | 否 | 项目描述 |
PUT /api/v1/projects/1
Authorization: Bearer <token>
Content-Type: application/json
{
"name": "软件下载(更新)",
"prefix": "soft",
"description": "更新后的描述"
}
删除项目
DELETE /api/v1/projects/1
Authorization: Bearer <token>
⚠️ 删除项目时,项目下的所有链接也会一并删除。
👉 下一节:链接管理接口