rest api

api

순수하게 데이터 처리 (등록, 조회, 수정, 삭제)를 요청하는 방식

• “API”는 지정된 형식의 주소를 호출하면 정해진 데이터를 돌려주는 방식이다.
• “Rest API”라는 API를 설계하는 새로운 방식이 등장했다.
• 사용자 요청을 파악할 수 있도록 “API”를 설계하는 방식을 말한다.

설계방법 (1)

• 주소의 구조를 보면 게시물 정보를 요청하는 것을 알 수 있다. 즉, 자원을 알 수가 있다.
• 주소의 구조를 보면 목록조회를 요청하는 것을 알 수 있다. 즉, 어떤 서비스 요청인지 알 수가 있다.

설계방법 (2)

• GET은 정보를 조회할 때 사용한다.
• CREATE는 새로운 정보를 추가할 때 사용한다.
• PUT은 정보를 변경할 때 사용한다.
• DELETE은 정보를 삭제할 때 사용한다.

@RestController

• 해당 컨트롤러는 REST 방식으로 API를 처리한다는 것을 의미한다.
• 리턴타입에 @ResponseBody가 적용되는 효과가 있다.

• @Controller는 String 반환타입을 사용하면 JSP와 같은 화면을 전달하였다.
• 반면 @RestController는 순수한 데이터를 전달한다.

반환타입

• 클라이언트인 브라우저는 클래스를 표기 할 수 없다.
• 브라우저에서는 JSON 데이터포맷을 사용할 수 있다.

상태코드

*2xx: 처리성공을 의미한다
*3xx: 리다이렉트를 의미한다
*4xx: 클라이언트 오류를 의미한다
*5xx: 서버 오류를 의미한다

Swagger란?
• API 정보를 자동으로 문서화한다.
• API 목록, 사용방법, 파라미터정보를 게시한다.
• API 테스트 기능 제공한다

Open API란?
- 누구나 사용할 수 있도록 공개된 API를 말한다.
- 개발자는 이를 이용해 다양한 서비스를 개발할 수 있다.

dev-hyeonnnnn