API 관리
아이디 | 이름 | ||||||
---|---|---|---|---|---|---|---|
API URI | |||||||
API 타입 | 도움말 | 연산유형 | |||||
응답결과 타입 | 데이터소스 | ||||||
웹서비스 요청 |
|
||||||
SQL | |||||||
Procedure | |||||||
파라미터 | |||||||
결과샘플 | |||||||
설명 (0/500bytes) |
|||||||
최초 생성일 | 최초 생성자 | ||||||
최종 변경일 | 최종 변경자 |
- * webservice *
응답결과는 요청헤더의 Content-Type, Accept 순으로 확인해서 마지막으로 만나는 것이 최종 응답유형이된다. 예를들어 Content-Type이 XML이고, Accept는 JSON이라면 최종적으로 JSON이 응답유형이 된다.
이 응답 유형이 JSON인 경우에 한해서 응답결과타입(MAP, LIST, INT)이 유효한데, INT는 사용되지 않는다.
응답결과는 XML, JSON, URL-ENCODE가 준비되어 있으며 이외의 경우에는 Map에 key를 text로 하여 응답결과를 붙여서 반환한다. 응답결과가 XML이면 JSON객체로 반환한다.
응답결과가 JSON이고, 응답결과타입이 LIST인 경우 리턴타입은 List<Map<String, Object>> 이다.
응답결과가 JSON이고, 응답결과타입이 MAP인 경우 리턴타입은 Map<String, Object>이다.
URL-ENCODE의 경우 리턴타입은 MultiValueMap<String, String> 이다.
- * sql *
HttpMethod타입에 따라서 질의문이 실행되는데 HttpMethod타입이 GET인 경우와 그렇지 않은 경우로 분류된다.
GET인 경우 응답결과타입이 MAP인 경우, queryForMap형태로 질의문이 실행된다. 즉, 결과가 1개인 SELECT문이 적합하다.
LIST인 경우에는 queryForList형태로 질의문이 실행되므로, 결과가 2개 이상인 SELECT문에 적합하다. INT는 부적절한 응답결과타입이다.
HttpMethod타입이 GET이 아닌경우, INT가 아니면 부적절한 응답결과 타입이며 질의문은 INSERT, UPDATE, DELETE문이 적합한다. 반환되는 값은 해당 질의문에 의해 영향받은 row의 갯수이다.- * procedure *
Procedure 입력란(Api.targetName) 작성이 필요한다. 지정하는 형태는 다음과 같다.
(1) {procedure name}
(2) {schema name}.{procedure name}
(3) {schema name}.{catalog name}.{procedure name}
이외의 경우는 부적절한 형태이다. 실행결과는 응답결과타입에 상관없이 Map<String, Object>이다.- * myBatis *