RESTful API 의미 예제 예시 이해 명세서

👉 API가 무엇인가?

Application Programming Interface의 줄임말

API를 통해서 클라이언트와 서버가 통신 할 수 있게 해주고, 서버와 DB와 통신을 주고 받아 사용자가 원하는 화면을 보여준다.

 

 👉  REST란?

HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미

 

👉  RESTful은?

REST를 REST답게 쓰기 위한 방법, REST 원리를 따르는 시스템을 RESTful이란 용어로 부르는 것

 

예시 

- api/user

[GET] user 리스트 출력

- api/user

[POST] user 생성

👀 같은 URI를 사용하여 GET 일 경우와 POST일 경우에 로직을 다르게 하여 응답한다

 

목적 

- 성능 향상이 아니다

- 이해하고 사용하기 쉬운 REST API를 만드는 것

- 일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높이는 것

 

API 명세서 예시