wp-rest-api

wp-rest-api 스킬 개요

wp-rest-api는 무엇을 위한 스킬인가

wp-rest-api 스킬은 WordPress REST 엔드포인트 작업에서 시행착오를 줄여줍니다. 라우트 생성, 콘텐츠 타입 노출, 파라미터 검증, 응답 구조 설계, 인증 또는 권한 실패 수정까지 더 정확하게 다룰 수 있게 도와줍니다. 단순한 범용 프롬프트가 아니라, 실제 플러그인·테마·mu-plugin 안에서 API Development를 위한 실용적인 wp-rest-api 가이드가 필요할 때 가장 유용합니다.

누가 사용해야 하나

register_rest_route(), WP_REST_Controller, register_rest_field, register_meta, show_in_rest, 또는 REST 스키마/검증 로직을 추가하거나 디버깅하는 경우 wp-rest-api 스킬을 사용하세요. 이 스킬은 리포지토리가 엔드포인트 작업을 제대로 지원하는지, 그리고 안전하게 접근하는 방법이 무엇인지 빠르게 판단해야 하는 개발자에게 특히 잘 맞습니다.

무엇이 다른가

이 스킬은 도입을 자주 가로막는 WordPress 고유 제약에 초점을 맞춥니다. permission_callback, nonce 또는 application password 인증, 라우트 네임스페이스, context=edit, _fields, 스키마 기반 검증이 그 핵심입니다. wp-rest-api의 가장 큰 가치는 코딩을 시작하기 전에 올바른 REST 패턴으로 방향을 잡아준다는 점입니다. 덕분에 잘못된 권한 처리, 클라이언트 회귀, 잘못된 응답 형태를 줄일 수 있습니다.

wp-rest-api 스킬 사용법

설치하고 범위를 확인하기

npx skills add WordPress/agent-skills --skill wp-rest-api로 wp-rest-api 스킬을 설치하세요. 편집에 들어가기 전에 올바른 repo root에 있는지 확인하고, 정확한 플러그인/테마 엔트리포인트를 찾으세요. 프로젝트가 전체 사이트 코드베이스라면, 엔드포인트를 소유한 단일 컴포넌트로 범위를 좁히는 것이 좋습니다.

최소 입력값을 먼저 모으기

최고의 wp-rest-api install 결과를 원한다면 다음 정보를 제공하세요: 대상 namespace와 버전, route path, 사용할 HTTP method, 인증 방식, 그리고 WordPress 버전 기준선. 약한 요청은 “엔드포인트를 추가해줘”입니다. 더 강한 요청은 이런 식입니다. “인증된 편집자용으로 my-plugin/v1/orders를 추가하고, order ID, status, total만 반환해줘. page와 per_page를 검증하고, 클라이언트 성능을 위해 ?_fields=도 지원해줘.”

먼저 올바른 파일부터 읽기

SKILL.md부터 시작한 뒤 references/routes-and-endpoints.md, references/authentication.md, references/schema.md, references/responses-and-fields.md, references/discovery-and-params.md, references/custom-content-types.md를 확인하세요. 이 파일들은 라우트, 권한, 스키마, 콘텐츠 노출이 어떻게 연결되어야 하는지 스킬이 기대하는 방식을 알려줍니다. 무작정 repo를 훑는 것보다 훨씬 실용적입니다.

실전 워크플로를 따르기

이 스킬을 사용해 기존 REST 사용 방식을 먼저 분류한 뒤, 구현 경로를 선택하세요. 커스텀 라우트, 컨트롤러 클래스, 기존 타입 노출 중 하나가 될 수 있습니다. 프롬프트는 엔드포인트 이름만이 아니라 의도한 리소스 형태를 중심으로 구성하세요. 예를 들어 응답이 공개용인지 edit-only인지, core fields를 재사용할지, 데이터가 post meta인지 CPT인지 계산된 로직인지까지 포함하는 식입니다. 그래야 모델이 실제로 쓸 수 있는 wp-rest-api usage 결과를 내놓을 수 있습니다.

wp-rest-api 스킬 FAQ

커스텀 라우트에만 쓰는 건가요?

아닙니다. wp-rest-api 스킬은 show_in_rest를 통한 CPT와 taxonomy 노출, custom fields나 meta 추가, 기존 엔드포인트의 응답 동작 조정에도 잘 맞습니다. 단발성 fetch 예시만 필요하다면 일반 프롬프트로도 충분할 수 있지만, 라우트 설계나 호환성 점검이 필요하다면 이 스킬이 더 적합합니다.

언제 wp-rest-api를 쓰지 않는 게 좋나요?

WordPress REST 내부와 무관한 작업이라면 건너뛰세요. 이미 안정화된 API만 소비하는 client app에서 작업하는 경우도 마찬가지입니다. 서버 코드를 바꿀 수 없고 문서나 요청 예시만 필요하다면 이 스킬은 좋은 선택이 아닙니다.

초보자도 쓰기 쉬운가요?

WordPress PHP 파일을 편집할 수 있고, 원하는 리소스를 명확하게 설명할 수 있다면 그렇습니다. 초보자에게 가장 큰 위험은 auth와 permissions를 너무 적게 적는 것입니다. 그러면 라우트는 동작하는 것처럼 보여도 로그아웃 사용자, 편집자, 외부 클라이언트에서는 실패할 수 있습니다.

일반 프롬프트와 비교하면 어떤가요?

일반 프롬프트는 코드를 제안해줄 수 있지만, wp-rest-api는 WordPress 전용 안전장치가 필요할 때 더 유용합니다. 필수 permission_callback, 스키마 검증, 응답 형태 조정, 라우트 discovery가 그 예입니다. 그래서 단순 문법보다 신뢰성이 중요할 때 설치를 결정하기에 더 적합한 스킬입니다.

wp-rest-api 스킬 개선 방법

목표만이 아니라 리소스 형태를 알려주기

가장 효과적인 개선 방법은 엔드포인트가 무엇을 반환해야 하는지, 누가 호출할 수 있는지를 구체적으로 적는 것입니다. object type, fields, write access, 특수 필터를 명시하세요. 예를 들어 “발행된 products를 id, name, price, stock_status와 함께 반환하고, 인증된 managers만 stock_status를 업데이트할 수 있게 해줘”처럼요. 이렇게 하면 wp-rest-api 스킬의 정밀도가 훨씬 높아집니다.

실패 상황을 먼저 제공하기

디버깅 중이라면 401, 403, 404, 누락된 nonce, 잘못된 namespace, invalid schema 같은 정확한 증상을 포함하세요. 라우트가 public인지, cookie-authenticated인지, application passwords를 사용하는지도 적어두세요. 이렇게 하면 모델이 인증 실패와 라우트 등록 문제, 데이터 형태 문제를 구분하는 데 도움이 됩니다.

프롬프트에 repo 세부 정보를 넣기

이미 repo에 존재하는 관련 파일, 컨트롤러 클래스, post type 이름을 명시하세요. 코드에 이미 show_in_rest, rest_base, meta registration이 있다면 그것도 함께 적으세요. 가장 좋은 wp-rest-api guide 결과는 보통 새로 처음부터 구현해 달라고 하는 요청보다, 기존 아키텍처에 기대어 요청할 때 나옵니다.

검증에서 다듬기로 점진적으로 개선하기

첫 출력 이후에는 한 번에 하나씩만 좁혀서 개선을 요청하세요. 더 엄격한 schema, 더 나은 permission check, _fields를 이용한 응답 축소, non-pretty permalinks와의 route 호환성 같은 항목이 좋습니다. 출력 품질이 여전히 만족스럽지 않다면, 정확한 요청과 기대하는 JSON 형태를 추가해 프롬프트를 더 조이세요. 보통 “더 나은” 엔드포인트를 요청하는 것보다 훨씬 효과적입니다.