Documentation

상태코드별 응답

HTTP 상태 코드별 응답 스키마와 테스트 요청

3 min read

같은 API 라도 상황에 따라 다른 응답을 돌려줍니다 — 성공하면 결과 데이터를, 실패하면 오류 정보를 보냅니다. Layerz 는 HTTP 상태 코드별로 응답의 모양 을 정의할 수 있습니다.

상태 코드별 응답 스키마

응답 스키마는 상태 코드(또는 코드 묶음)별로 정의합니다.

  • 200 — 정확한 코드
  • 4XX — 4로 시작하는 코드 묶음
  • default — 위에 해당하지 않는 나머지

요청 후 실제로 받은 상태 코드에 맞는 응답만 데이터 구조로 파싱됩니다. 매칭은 정확한 코드 → 코드 묶음 → default 순서로 이루어집니다.

응답의 형태

API Call 액션의 출력은 다음 구조를 가집니다.

  • HTTPStatusCode — 실제 응답 상태 코드
  • Data — 원본 응답 데이터
  • 상태 코드별 필드 — 받은 상태에 해당하는 응답이 데이터로 파싱되어 들어갑니다.

이 출력을 조건과 분기와 함께 쓰면 2XX 일 때와 4XX 일 때를 다르게 처리할 수 있습니다.

Send Test Request

응답 스키마를 손으로 정의하기 어렵다면, Send Test Request 버튼으로 실제 요청을 한 번 보내 보세요. 돌아온 JSON 응답을 바탕으로 응답 스키마를 자동으로 생성해, 받은 상태 코드에 매핑해 줍니다.

OpenAPI/Swagger 를 가져오면 스펙에 선언된 상태 코드별 응답 스키마가 자동으로 만들어집니다. 직접 만들 때는 Send Test Request 로 시작하는 것이 가장 빠릅니다.