链接

链接管理相关操作。

接口

GET /api/links
GET /api/links/:linkId
POST /api/links/:linkId
DELETE /api/links/:linkId

返回所有用户链接。

参数

  • search:(可选字符串)搜索文本。
  • page:(可选数字,默认 1)指定页码。
  • pageSize:(可选字符串)指定返回结果数量。

示例响应

{
  "data": [
    {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "name": "umami",
      "url": "https://www.umami.is",
      "slug": "xxxxxxxx",
      "userId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "teamId": null,
      "createdAt": "2025-10-27T18:49:39.383Z",
      "updatedAt": "2025-10-27T18:49:39.383Z",
      "deletedAt": null
    }
  ],
  "count": 1,
  "page": 1,
  "pageSize": 20
}

GET /api/links/:linkId

通过 ID 获取链接。

示例响应

{
  "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "name": "umami",
  "url": "https://www.umami.is",
  "slug": "xxxxxxxx",
  "userId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "teamId": null,
  "createdAt": "2025-10-27T18:49:39.383Z",
  "updatedAt": "2025-10-27T18:49:39.383Z",
  "deletedAt": null
}

POST /api/links/:linkId

更新链接。

参数

  • name:(可选字符串)链接名称。
  • url:(可选字符串)链接目标 URL。
  • slug:(可选字符串 | 最少 8 个字符)链接的 URL slug。

请求体

{
  "name": "umami",
  "url": "https://www.umami.is"
}

示例响应

{
  "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "name": "umami",
  "url": "https://www.umami.is",
  "slug": "xxxxxxxx",
  "userId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "teamId": null,
  "createdAt": "2025-10-27T18:49:39.383Z",
  "updatedAt": "2025-10-30T23:06:01.824Z",
  "deletedAt": null
}

DELETE /api/links/:linkId

删除链接。

示例响应

{
  "ok": true
}