GET /components/{name}

根据名称获取单个自定义组件的完整字段定义。

根据名称获取单个自定义组件的完整定义，包括其字段列表。

认证： API 密钥（x-api-key 请求头或 api_key 查询参数）。

路径参数

参数	类型	必填	说明
`name`	string	是	架构名称，例如 `post`。

查询参数

参数	类型	必填	说明
`websiteId`	uuid	是	必须是有效的 UUID。
`api_key`	string	否	`x-api-key` 请求头的替代方案。

响应

{
  "id": "...",
  "name": "post",
  "displayName": "文章",
  "description": "一篇文档文章",
  "category": "自定义",
  "titleField": "title",
  "routeSlugField": "title",
  "icon": null,
  "fields": [
    { "name": "title", "type": "string", "required": true }
  ],
  "slugFields": ["title", "description"],
  "version": 8
}

slugFields 是计算得出的——所有字符串类型字段的名称。

示例

curl '{CMS_API_URL}/components/post?websiteId=<uuid>' \
  -H 'x-api-key: <key>'

错误

400 — 缺少或无效的 websiteId
401 — 无效的 API 密钥
404 — 未找到架构

Previous‹GET /components NextGET /dataset/{schema_name}›