dev.info
REST API
seuhyang
2023. 7. 20. 17:01
해당 게시물은 아래의 주소를 참고한 게시물입니다.
https://meetup.toast.com/posts/92
REST API의 탄생
- REST는 Representational State Transfer 의 약자이며 웹의 장점을 최대한 활용할 수 있는 아케텍처로써 REST를 발표 했다.
REST의 구성
- REST API는 다음과 같이 구성되어 있다.
- 자원(Resource) - URI
- 행위(Verb) - HTTP METHOD
- 표현(Representations)
REST의 특징
- Uniform
- Stateless
- Cacheable
REST API 디자인 가이드
- 첫번째, URI는 정보의 자원을 표현해야 한다.
- 두번째, 자원에 대한 행위는 Method(GET, POST, PUT, DELETE)로 표현한다.
- 2-1) URI는 정보의 자원을 표현해야 한다. ( resource 명은 동사보다 명사를 사용)
get('/student/update/:idx') // 잘못된 URI의 예시
put('/student/:idx')| Method | 역할 |
| POST | POST를 통해 해당 URI를 요청하면 리소스를 생성합니다. |
| GET | GET를 통해 해당 리소스를 조회합니다. |
| PUT | PUT를 통해 리소스를 수정합니다. |
| DELETE | DELETE를 통해 리소스를 삭제합니다. |
위의 4개의 Method로 CRUD를 구현한다.
- 2-2) URI 설계 시 주의할 점
- 슬래시(/) 는 계층 관계를 나타내는 데 사용한다.
- URI 마지막 문자로 슬래시(/)를 포함하지 않는다.
// URI는 계층 관계를 나타낸다
localhost:3000/depth1/depth2/depth3
// 예시
localhost:3000/user/profile
localhost:3000/clothes/woman/category?name=pants
localhost:3000/clothes/man/category?name=pants
해당 게시물은 아래의 주소를 참고한 게시물입니다.