일반적으로 API 설계에서 성공적인 200 OK 응답은 서로 다른 출력 데이터 요구 사항으로 인해 다양한 엔드포인트마다 다른 경우가 많지만, 400 Bad Request 및 404 Not Found와 같은 오류 응답은 서로 다른 엔드포인트 전반에서 일관되는 경향이 있습니다.Apidog는 응답 컴포넌트 기능을 통해 이러한 공통성을 스마트하게 처리합니다. 이 기능을 사용하면 사전 정의된 오류 응답을 재사용할 수 있어 API 문서화 프로세스가 더 효율적이 되고 API 동작이 더 일관되게 유지됩니다.응답 컴포넌트 추가하기#
APIs 모듈의 왼쪽 디렉터리 트리에서 Components 섹션으로 이동한 다음, Responses 아래의 New Response를 클릭하여 새 응답 컴포넌트를 생성하십시오.응답 컴포넌트를 생성하는 것은 엔드포인트를 정의할 때 응답 섹션을 지정하는 것과 유사하며, HTTP 상태 코드, Content type, Schema, Examples를 포함합니다. 자세한 안내는 Endpoint Basics의 응답 섹션을 참조하십시오.응답 컴포넌트의 고유 기능#
새 엔드포인트에 기본적으로 추가됨: "Yes"로 선택하면, 이 컴포넌트가 프로젝트에 추가되는 모든 새 엔드포인트에 기본적 으로 자동 포함됩니다.
기존 엔드포인트는 이 설정의 영향을 받지 않습니다.
응답 컴포넌트 참조하기#
엔드포인트의 Response 섹션에서 사전 정의된 응답 컴포넌트를 참조할 수 있습니다.참조된 응답 컴포넌트는 엔드포인트 내에서 수정할 수 없습니다. 원본 응답 컴포넌트를 변경해야 합니다. 변경 사항은 이 컴포넌트를 참조하는 모든 엔드포인트에 영향을 미칩니다.
엔드포인트에서 참조된 응답 컴포넌트를 수정하려는 경우, 이를 참조 해제할 수 있습니다. 참조를 해제하면 해당 응답은 일반적인 편집 가능한 응답으로 전환되며, 응답 컴포넌트의 변경 사항은 더 이상 해당 응답에 영향을 주지 않습니다.
엔드포인트에서는 하나의 컴포넌트를 한 번만 참조할 수 있으며, 동일한 컴포넌트의 여러 인스턴스가 같은 엔드포인트 내에 공존할 수 없습니다.
일괄 작업#
기존 응답 컴포넌트를 선택한 엔드포인트에 일괄적으로 추가하거나, 선택한 엔드포인트에서 이 컴포넌트를 일괄적으로 제거할 수 있습니다.선택한 엔드포인트에 이미 이 응답 컴포넌트가 포함되어 있으면 다시 추가되지 않습니다.
선택한 엔드포인트에 이 응답 컴포넌트가 포함되어 있지 않으면 제거 작업은 적용되지 않습니다.
기본 응답 템플릿#
많은 회사에서는 응답에 대한 표준화된 구조를 가지고 있습니다. 이러한 경우 기본 응답 템플릿을 활용하여 회사의 고정 구조를 기본 응답 템플릿으로 유지할 수 있습니다.왼쪽 디렉터리 트리의 Components 섹션 아래에서 Default Response Template 기능에 접근하고 사용할 수 있습니다.새 엔드포인트가 생성되면 이 템플릿의 내용이 초기 응답으로 사용됩니다.기본 응답 템플릿에 적용한 변경 사항은 새 엔드포인트에만 영향을 미치며, 기존 엔드포인트는 영향을 받지 않습니다.
기본 응답 템플릿은 하나만 존재하며, 추가하거나 제거할 수 없습니다.
초기 기본 응답 템플릿은 Content type이 JSON이고 데이터 구조가 빈 Object 노드인 200 Success Response입니다.
FAQ#
Q: 응답 컴포넌트를 기본 응답으로 사용할 수 있습니까?A: 아니요. 응답 컴포넌트는 400, 404 및 유사한 상태 코드와 같은 일반적인 오류 응답을 위한 것입니다. 고정된 기본 응답을 사용해야 하는 경우 기본 응답 템플릿을 사용하십시오. 