Create Responses & Messages

학습 목표

이 모듈을 마치면 다음을 수행할 수 있습니다.

• REST API 내에서 응답과 메시지의 역할을 설명하세요
• REST 응답에서 가장 일반적으로 사용되는 일부 상태 코드를 인식합니다.
• 오류 응답이 준수해야 하는 지침을 설명하세요.

---

API의 목적은 데이터를 생성, 업데이트, 읽기 또는 삭제하여 정보를 교환하는 것입니다.

상태 코드 및 이유 구문

• 4xx: 사용자로 인해 발생한 오류이며, 요청을 변경해야 합니다.
• 5xx: 서버 자체에 문제가 있습니다.

아래는 몇가지 예시를 나타낸 표 입니다

[ 그림 1 ]

 

API를 빌드할 때 올바른 상태 코드와 해당 이유 문구를 반환하는 것이 중요합니다. 왜냐하면 통합 시스템은 API에서 제공한 정보에 따라 결과적인 작업을 결정하기 때문입니다.

 

오류 메시지

REST 요청을 처리하는 동안 오류가 발생하면 요청자에게 문제를 직접 해결할 수 있는 충분한 정보가 제공되어야 합니다. 결과적으로 API는 요청자에게 가능한 한 자세한 응답을 제공해야 합니다.

오류 응답의 내용은 다음 지침을 준수해야 합니다.

• 응답 본문에는 SystemMessage 특성이 포함되어야 합니다.
• SystemMessage에는 개발자를 위한 기술 정보가 포함될 수 있습니다.
• 응답 본문에는 UserMessage 속성이 포함될 수 있습니다.
• UserMessage에는 기술 정보가 포함되어서는 안 됩니다.
• UserMessage는 시스템의 최종 사용자가 다음에 어떤 단계를 취해야 하는지 알 수 있도록 구성되어야 합니다(UserMessage는 실제로 사용자에게 표시된다고 가정).
• 응답은 단일 오류 객체 또는 오류 객체 목록입니다.
• 오류 메시지에는 구현 세부 정보(예: 스택 추적)가 노출되어서는 안 됩니다.

 

 

Validation 재사용성

때로는 이미 제공되고 있는 것과 동일한 기능을 제공하는 휴식 서비스가 만들어지기도 합니다.

Validation Feedback Collector 모듈 사용하여 검증 오류 메시지를 만드는 한 가지 접근 방식을 볼 수 있습니다 . 이 접근 방식의 이점은 기존 검증 흐름을 재사용할 수 있다는 것입니다. 서비스에 맞는 검증을 빌드하고 프로젝트에 적합한 것을 사용할 수도 있습니다.

[ 그림 2 ]

 

 

 

 

 

출처 : https://academy.mendix.com/link/paths/133/Design-and-Publish-a-REST-API

참고 :
https://http.cat/

https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html