관리 메뉴

nalaolla

Api 개발시 결과 모델 전달 가이드 본문

프로젝트 개발정보

Api 개발시 결과 모델 전달 가이드

날아올라↗↗ 2017. 12. 4. 22:47
728x90

API를 개발하면서 처리 결과에 대한 메세지 정보  또는 객체를 전달할 필요가 있다 

get(select)  API  호출 결과는 보통 조회된 데이터 객체 유무로 결과값을 확인할수 있으나 

CUD(CRUD 에서 R 제외) 호출시에는  통신 결과에 대한 상태코드값(HttpStatus) 뿐만 아니라 경우에 따라서  업무성 코드값및 데이터 객체를 받을 필요가 있다 

따라서 이에 대한 가이드가 필요하여 다음과 같이 가이드 한다 


기존에 배포된 ResultMessage.java 클래스에  다음과 같이 code, data 값을 추가 하였다

따라서 업무성 코드및 데이터 객체를 담아서 전달할수 있다  


@Data
@AllArgsConstructor
public class ResultMessage {
    private String successYn; // 성공 여부 
    private String statusCode; // HttpStatus code
    private String code; // 업무성 코드
    private Object data;  // 데이터 객체
    private String message; // 메세지
    private String devMessage; // 개발자용 메세지
     
     
    public ResultMessage() {       
    }
 
    public ResultMessage(String successYn) {
        this.successYn = successYn;
        this.statusCode = null;
        this.code = null;
        this.message = null;
        this.data = null;
        this.devMessage = null;
    }
    public ResultMessage(String successYn, String message) {
        this.successYn = successYn;
        this.statusCode = null;
        this.code = null;
        this.data = null;
        this.message = message;    
        this.devMessage = null;
    }
     
    public ResultMessage(String successYn, String code, Object data, String message) {
        this.successYn = successYn;
        this.statusCode = null;
        this.code = code;
        this.data = data;
        this.message = message;    
        this.devMessage = null;
    }
     
}


728x90