URL 경로로 단일 라우트를 해석하며, 매개변수 매칭과 검증된 매개변수 문서를 포함합니다.
주어진 경로에 대한 단일 라우트를 해석합니다. 경로가 정확히 일치하면 해당 항목이 우선하며, 그렇지 않으면 가장 높은 점수를 받은 매개변수 패턴이 선택되고, 연결된 매개변수는 문서로 검증되며, 유효한 블록이 계산됩니다. 선택적으로 해석된 매개변수 문서를 반환합니다.
인증: API 키(x-api-key 헤더 또는 api_key 쿼리 매개변수).
| 매개변수 | 유형 | 필수 | 비고 |
|---|---|---|---|
websiteId | UUID | 예 | 대상 웹사이트. |
path | 문자열 | 예 | 해석할 URL 경로(예: /docs/getting-started). |
api_key | 문자열 | 아니요 | x-api-key 헤더의 대안입니다. |
preview | 불리언 | 아니요 | 기본값은 false입니다. true이면 초안 콘텐츠를 기준으로 해석하며 게시된 문서가 필요하지 않습니다. |
skipValidation | 불리언 | 아니요 | 기본값은 false입니다. true이면 매개변수 검증 실패 시 404가 발생하지 않습니다. |
{
"route": {
"path": "/docs/us/guide",
"pattern": "/docs/{country}/guide",
"block_ids": ["..."],
"state": "Live",
"param_bindings": { "country": "country" }
},
"resolvedParams": {
"country": {
"value": "us",
"schemaName": "country",
"document": { "id": "...", "schema_name": "country", "title": "United States", "published_content": {} }
}
}
}
route는 GET /routes의 항목과 동일한 구조를 갖습니다. resolvedParams는 라우트에 매개변수 바인딩이 있고 하나 이상의 문서가 해석된 경우에만 포함됩니다. language 스키마에 바인딩된 매개변수는 데이터베이스가 아니라 지원되는 언어의 기본 목록과 대조하여 해석됩니다.
curl '{CMS_API_URL}/route?websiteId=<uuid>&path=/docs/getting-started' \
-H 'x-api-key: <key>'
400 — websiteId 누락/잘못됨, 또는 path 누락/비어 있음401 — 잘못된 API 키404 — 라우트를 찾을 수 없거나 매개변수 검증 실패(skipValidation=true인 경우 제외)