spring boot - 공통 api 만들기

사람들이 항상 올바른 요청만 한다면 정말 행복한 세상이 될 것입니다. 하지만 인증 번호를 틀리거나 해킹을 하거나 로그아웃이 되었는데 그걸 모르고 권한이 없는 요청을 하기도 하죠. 그런 일이 발생했을 때도 제대로 된 응답을 내려주기 위해 Api 응답을 잘 꾸며주도록 하겠습니다.

구조 만들기

저는 다음과 같은 구조를 만들 것입니다.

{
	"result": {
		"result_code" : 200
		"result_message" : "OK"
		"result_description" : "유저 등록 완료!"
	},
	"body": {
		~~~
	}
}

 

body는 응답에 따라 달라질 수 있습니다.

 

우선 result부분부터 만듭니다.

 

그리고 Api 클래스를 만듭니다. body는 바뀔 수 있기 때문에 generic으로 만들어 줍니다.

 

정상적인 요청이 많이 올 것이기 때문에 OK를 담당하는 메소드를 만들겠습니다. result부터 꾸며줍니다.

 

그리고 Api에도 하나 만들어 줍니다.

 

테스트

health를 확인하는 api입니다.

 

이것을 Api 클래스를 사용하도록 바꾸겠습니다.

 

원래는 문자 하나만 내려왔지만 이제 형식이 갖추어 진 것을 볼 수 있습니다.