이 질문은 약간의 의견을 기반으로하지만 어느 쪽이든입니다.

내가 보는 방식으로 200은 “소프트 오류”를 제공 할 수 있습니다. API를 빌드 할 때 이러한 오류와 “하드 오류”를 구별하려고합니다.

“소프트 오류” 는 상태 코드 200으로 제공되지만 오류 설명 및 성공 상태는 포함 false됩니다. “소프트 오류”는 결과가 “예상 한”경우에만 발생하지만 가장 엄격한 의미에서는 성공하지 않습니다.

“소프트 에러”는 구현 자 에게 힌트 가된다는 점에 유의해야합니다 . 따라서 사람이 읽을 수있는 오류 메시지 및 / 또는 최종 사용자에게 피드백을 제공하는 데 사용할 수있는 일종의 코드와 같은 오류에 대한 자세한 정보 를 제공하는 것이 중요합니다 . 이러한 오류는 구현 자 (및 최종 사용자)에게 서버 측 에서 발생한 일에 대한 자세한 정보를 제공합니다 .

예를 들어 검색 기능이있는 API가 있지만 검색 중에 결과가 나오지 않는다고 가정하십시오. 이것은 잘못된 것은 아니지만 정의의 가장 엄격한 의미가 아닌 “성공”도 아닙니다.

JSON 형식의 예 :

{
    "meta" {
        "success": false,
        "message": "Search yielded no results",
        "code": "NORESULTS"
    }
    "data": []
}

반면에 “하드 오류” 는 오류에 권장되는 상태 코드와 함께 제공됩니다. 사용자가 로그인하지 않았습니까? – 403/401. 잘못된 입력? – 400. 서버 오류? – 50X. 등등.

다시 말하지만 약간의 의견 기반입니다. 어떤 사람들은 모든 오류를 똑같이 “하드 오류”로 취급하려고합니다. 검색 결과가 없습니까? 404입니다! 동전 반대편에 검색 결과가 없습니까? – 예상대로 오류가 없습니다.

고려해야 할 또 다른 중요한 요소는 아키텍처입니다. JavaScript XHR 요청 및 jQuery 또는 AngularJS를 사용하여 API와 상호 작용하는 경우 이러한 “하드 오류”는 별도의 콜백으로 처리해야하지만 “소프트 오류”는 “성공”-콜백으로 처리 할 수 ​​있습니다. 아무것도 깨뜨리지 않아도 결과는 여전히 “예상대로”입니다. 클라이언트 측 코드는 성공 상태 및 코드 (또는 메시지)를 볼 수 있습니다. 그리고 최종 사용자에게 인쇄하십시오.

답변