链接
链接管理相关操作。
接口
GET /api/links
POST /api/links
GET /api/links/:linkId
POST /api/links/:linkId
DELETE /api/links/:linkIdGET /api/links
返回所有用户链接。
参数
| Parameter | Type | Description |
|---|---|---|
search | string | （可选）搜索文本。 |
page | number | （可选，默认 1）确定页码。 |
pageSize | number | （可选）确定返回结果数量。 |
示例响应
{
"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
}POST /api/links
创建链接。
Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | 链接名称。 |
url | string | 链接的目标 URL。 |
slug | string | 链接的 URL slug（最少 8 个字符）。 |
teamId | string | （可选）将在其下创建链接的团队 ID。 |
Request body
{
"name": "umami",
"url": "https://www.umami.is",
"slug": "umami123"
}Sample response
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "umami",
"url": "https://www.umami.is",
"slug": "umami123",
"userId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"teamId": null,
"createdAt": "2025-10-27T18:49:39.383Z",
"updatedAt": "2025-10-27T18:49:39.383Z",
"deletedAt": null
}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
更新链接。
参数
| Parameter | Type | Description |
|---|---|---|
name | string | （可选）链接名称。 |
url | string | （可选）链接的目标 URL。 |
slug | string | （可选）链接的 URL slug（最少 8 个字符）。 |
请求体
{
"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
}