필드 사용 중단
GraphQL 스키마의 버전 관리에는 필드를 사용 중단하는 작업이 포함됩니다. 즉, 해당 필드를 더 이상 사용하지 말아야 한다는 것을 사용자에게 알리고, 대체할 필드를 안내하는 것입니다.
코드를 통한 필드 사용 중단 외에도, Gato GraphQL은 어떤 필드를 어떻게 사용 중단할지 설정할 수 있는 사용자 인터페이스를 제공합니다.
설정은 필드 사용 중단 목록을 통해 생성되며, 스키마 설정을 통해 커스텀 엔드포인트와 퍼시스티드 쿼리에 전달됩니다.
모든 필드 사용 중단 목록 접근
플러그인 메뉴에서 "Field Deprecation Lists"를 클릭하면, 생성된 모든 필드 사용 중단 목록이 표시됩니다.
새 필드 사용 중단 목록 생성
"Add New Field Deprecation List" 버튼을 클릭하여 WordPress 편집기를 엽니다.
필드 사용 중단 목록에 제목을 지정하고, 필드가 포함된 항목을 추가한 후, 사용 중단 메시지를 설정합니다. 준비가 완료되면 Publish 버튼을 클릭합니다. 그러면 새 필드 사용 중단 목록이 스키마 설정에서 사용 가능해집니다.
해당 필드는 스키마에서 사용 중단으로 표시되며, 추가로 사용 중단된 필드를 쿼리할 때 응답에 사용 중단 메시지가 표시됩니다(모듈 Deprecation Notifier가 활성화된 경우).
필드 사용 중단 항목
각 Field Deprecation List에는 하나 이상의 항목이 포함되며, 각 항목은 다음 요소로 구성됩니다.
- 사용 중단할 필드
- 사용 중단 메시지
인터페이스에서 필드 선택
타입의 필드뿐만 아니라, 인터페이스에서도 필드를 선택할 수 있습니다. 이 경우, 해당 인터페이스를 구현하는 모든 타입의 해당 필드에 대해 사용 중단이 적용됩니다.
필드 사용 중단 목록 설명
Document settings 패널의 "Excerpt" 필드를 사용하여 필드 사용 중단 목록에 설명을 추가합니다.
자세한 내용은 가이드 API에 설명 추가를 참조하세요.
필드 사용 중단 목록 사용
필드 사용 중단 목록을 생성한 후, 해당 스키마 설정을 편집하여 커스텀 엔드포인트 또는 퍼시스티드 쿼리에서 이를 사용하도록 설정하고, "Field Deprecation Lists" 블록 아래 목록에서 ACL을 선택할 수 있습니다.
설정을 커스터마이즈하지 않으면, "Field Deprecation" 탭의 설정 페이지에 정의된 기본 Field Deprecation Lists가 사용됩니다.
