项目管理接口

项目的增删改查接口,所有接口(除查询外)需要 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删除项目是

分页查询项目

查询参数

参数类型默认值说明
pageint1页码
page_sizeint20每页条数
keywordstring-搜索关键词

响应示例

{
  "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
  }
}

创建项目

请求参数

字段类型必填说明
namestring是项目名称
prefixstring是项目前缀(URL 路径标识)
descriptionstring否项目描述

请求示例

POST /api/v1/projects
Authorization: Bearer <token>
Content-Type: application/json

{
  "name": "软件下载",
  "prefix": "soft",
  "description": "软件分发项目"
}

更新项目

请求参数

字段类型必填说明
namestring是项目名称
prefixstring是项目前缀
descriptionstring否项目描述
PUT /api/v1/projects/1
Authorization: Bearer <token>
Content-Type: application/json

{
  "name": "软件下载(更新)",
  "prefix": "soft",
  "description": "更新后的描述"
}

删除项目

DELETE /api/v1/projects/1
Authorization: Bearer <token>

⚠️ 删除项目时,项目下的所有链接也会一并删除。

👉 下一节:链接管理接口