GET /components/{name}

이름으로 단일 커스텀 컴포넌트의 전체 필드 정의를 가져옵니다.

이름으로 단일 커스텀 컴포넌트의 전체 정의를 필드 목록과 함께 가져옵니다.

인증: API 키 (x-api-key 헤더 또는 api_key 쿼리 매개변수).

경로 매개변수

매개변수	유형	필수	설명
`name`	string	yes	예: `post`와 같은 스키마 이름.

쿼리 매개변수

매개변수	유형	필수	설명
`websiteId`	uuid	yes	유효한 UUID여야 합니다.
`api_key`	string	no	`x-api-key` 헤더에 대한 대안입니다.

응답

{
  "id": "...",
  "name": "post",
  "displayName": "Post",
  "description": "A documentation Post",
  "category": "Custom",
  "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‹컴포넌트 가져오기 Next데이터셋 스키마 이름 가져오기›