CatWiki 文档

Appearance

Client API ​

Client API 提供只读访问，无需认证，仅返回已发布的内容。

🌐 公开访问 ​

Client API 不需要身份认证，可以直接访问。

📚 API 端点 ​

站点信息 ​

  • GET /api/v1/sites - 获取已发布站点列表
  • GET /api/v1/sites/{id} - 获取站点详情
  • GET /api/v1/sites:byDomain/{domain} - 通过域名获取站点

文档浏览 ​

  • GET /api/v1/documents - 获取已发布文档列表
  • GET /api/v1/documents/{id} - 获取文档详情（自动增加浏览量）

合集浏览 ​

  • GET /api/v1/collections:tree - 获取合集树（仅已发布内容）

文件访问 ​

  • GET /api/v1/files/{path}:download - 下载文件
  • GET /api/v1/files/{path}:info - 获取文件信息
  • GET /api/v1/files/{path}:presignedUrl - 获取预签名 URL

💡 使用示例 ​

获取站点信息 ​

typescript
const response = await apiClient.sites.listClientSites({
  page: 1,
  size: 10
})

const sites = response.data.list

获取文档列表 ​

typescript
const response = await apiClient.documents.listClientDocuments({
  siteId: 1,
  page: 1,
  size: 20,
  excludeContent: true  // 不返回内容，加速加载
})

const docs = response.data.list

获取文档详情 ​

typescript
const response = await apiClient.documents.getClientDocument({
  documentId: 1
})

const doc = response.data

通过域名获取站点 ​

typescript
const response = await apiClient.sites.getClientSiteByDomain({
  domain: "example.com"
})

const site = response.data

📖 详细文档 ​

完整的 API 文档请访问：http://localhost:3000/docs

📚 相关文档 ​