728x90
반응형
1. REST API
API는 소프트웨어의 아키텍쳐(시스템구성)를 어떻게 형성할지에 대한 가이드 라인입니다.
REST API는 총 6개의 가이드라인이 존재하는데 이 조건들을 충족하면 RESTful 하다고 말합니다.
이 조건을 만족시키는 API를 RESTful API라고 말할 수 있습니다.
만약 몇 개의 조건만 따를 시엔 큰 의미로 REST API라고 불립니다.
2. REST 구성
- URI : 자원(Resource)
- HTTP METHOD : 행위(Verb)
- Representatitons(표현)
3. REST API 디자인 가이드
REST API 설계 시 가장 중요한 항목
1. URL은 정보의 자원을 표현해야 한다. (URL로 정보를 알 수 있어야함.)
2. 자원에 대한 행위는 HTTP Method로 표현한다.
4. HTTP Method (Request 요청)
REST를 활용한다고 HTTP의 특정 방식들을 의무적으로 사용해야하는 것은 아니지만 API에서는 일종의 컨벤션으로 해당 HTTP 메소드마다 통용되는 의미가 있습니다.
예를 들면 서버에 있는 데이터를 업데이트 한다고 해서 반드시 PATCH를 사용해야 하는 것은 아닙니다. POST를 사용할 수도 있습니다.
METHOD | 의미 |
POST | POST를 통해 해당 URI를 요청하면 리소스를 생성합니다. |
GET | GET를 통해 해당 리소스를 조회합니다. 리소스를 조회하고 해당 도큐먼트에 대한 자세한 정보를 가져온다. |
PUT, PATCH | PUT를 통해 해당 리소스 전체를 수정합니다. PATCH를 통해 해당 리소스 일부를 수정합니다. |
DELETE | DELETE를 통해 리소스를 삭제합니다. |
4. HTTP 상태 코드 (Response 응답)
- 100 번대 : 정보 응답
- 200 번대 : 성공 응답
- 300 번대 : 리다이렉션 메시지
- 400 번대 : 클라이언트 에러 응답
- 500 번대 : 서버 에러 응답
그 외
- 200 (OK)
- 201 (Created)
- 202 (Accepted)
- 204 (No Content)
- 301 (Moved Permanently) 등등
728x90
반응형
'Application > API' 카테고리의 다른 글
API 와 REST 정의 (0) | 2021.03.22 |
---|---|
API 관련 영상 및 자료 (0) | 2021.03.22 |