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": "Post",
  "description": "โพสต์สำหรับเอกสารประกอบ",
  "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‹GET /components NextGET /dataset/{schema_name}›

พารามิเตอร์

ชนิด

จำเป็น

หมายเหตุ

name

string

ใช่

ชื่อสคีมา เช่น post.

พารามิเตอร์

ชนิด

จำเป็น

หมายเหตุ

websiteId

uuid

ใช่

ต้องเป็น UUID ที่ถูกต้อง.

api_key

string

ไม่

เป็นทางเลือกแทนส่วนหัว x-api-key.

การตอบกลับ

{
  "id": "...",
  "name": "post",
  "displayName": "Post",
  "description": "โพสต์สำหรับเอกสารประกอบ",
  "category": "Custom",
  "titleField": "title",
  "routeSlugField": "title",
  "icon": null,
  "fields": [
    { "name": "title", "type": "string", "required": true }
  ],
  "slugFields": ["title", "description"],
  "version": 8
}

slugFields ถูกคำนวณขึ้น — เป็นชื่อของฟิลด์ที่มีชนิดเป็นสตริงทั้งหมด.