yanghun0070 / dayco

dayco project
MIT License
1 stars 0 forks source link

UAA Service HTTP Status Code 에 따라 Custom 메시지 정의 #25

Closed yanghun0070 closed 4 years ago

yanghun0070 commented 4 years ago

Custom 메시지 정의

성공 응답(httpstatus code 200)을 제외한 에러 응답의 경우 status, message 필드로 구성된다. 아래 메시지 구조는 아래와 같다. 에러메시지 정의는 locale/messages_ko.properties 존재한다.

{
"error": {
"status": [상태코드],
"message": [메시지 내용]
},
"_links": {
"self": {
"href": "호출한 url 주소"
}
}
}
HttpStatus Code Message
200 요청을 정상적으로 수행하였습니다.
204 요청한 API의 결과를 찾을 수 없습니다.
400 필수 파라미터가 누락되었거나 포맷이 일치하지 않습니다.
403 요청한 API의 권한이 없습니다.
404 유효하지 않는 API 주소입니다.
405 지원하지 않는 형식의 메서드입니다.
500 API 서비스 내부 시스템 오류가 발생하였습니다 관리자에게 문의하세요.
401 인증 실패하였습니다.
yanghun0070 commented 4 years ago

com.ykgroup.dayco.uaa.common.presentation.ExceptionControllerAdvice.java 에 404 를 제외하고, 나머지는 정의되어 있으므로, HttpStatus Code 404 추가

{
    "error": {
        "status": 404,
        "message": "유효하지 않는 API 주소입니다."
    },
    "_links": {
        "self": {
            "href": "http://localhost:9999/asd"
        }
    }
}