api 구현시 반환 형식을 어떻게 하시나요?

Question

현재 Client 1명, API Server 1명으로 토이 프로젝트 진행중입니다.(SpringBoot)json으로 데이터를 반환할때 상황에따라 반환하는 데이터가 다르고 어떨땐 메세지도 포함해서 보내야 할 때도 있는데.보통 그냥 ResponseEntity.body 에 그냥 데이터 넣고 반환하시나요 아니면 반환하는 형식을 정해두고 그 형식에 맞춰서 반환하시나요? 어떻게 하는게 더 보기 좋을지 고민입니다. 만약 형식에 맞춰서 한다면 어떤 형식으로 보내야할지도 막막한데 어떻게 하는게 좋을까요?

dlfkdu · Answer

구글에 ApiResponse 형식 한 번 검색해보시면 공통 응답 객체 포스팅 많아용

박레고 · Answer

{ "success": true, "message": "요청이 성공적으로 처리되었습니다.", "data": { // 실제 데이터 }}// 에러 발생 시{ "success": false, "message": "잘못된 요청입니다.", "errorCode": "400_BAD_REQUEST", "data": null}에러코드는 prefix 를 붙여서 prefix + code 형식으로 해도 되고요.

2948284 · Answer

class ApiResponsepub static ok()pub static ok(T data)pub static error(ApiStatus)pub static error(ApiStatus, T data)......리턴은 ResponseEntity로 래핑하는 메서드 여러개 구현해놓고 사용하면 편해요.결과적으론@GetMappingpub ResponseEntity getX() { return ApiResponse.ok();}이런 형태

wharup · Answer

REST API라면 @RestController 어노테이션을 달고 그냥 엔티티를 바로 보내면됩니다.@RestControllerpublic class UserController { Page findUsers() {}; List findUsers() {};}

api 구현시 반환 형식을 어떻게 하시나요?

4개의 답변

Q&A 목록