Restful API 작성법에 대한 안내
1. URI(Uniform Resource Identifier)
하나의 API 엔드포인트는 명사로 구성된 URI로 표현됩니다. 명사는 복수형으로 단어가 나열되며, 중요한 정보는 경로에 포함되어야 합니다. 예를 들면, "/users" 나 "/products" 와 같습니다.
2. HTTP 메소드
서버에 요청하는 메소드는 해당 리소스를 어떻게 다룰지를 나타내는 동사로 표현됩니다.
- GET: 리소스를 조회합니다.
- POST: 새로운 리소스를 생성합니다.
- PUT: 리소스를 업데이트 또는 생성합니다.
- DELETE: 리소스를 삭제합니다.
- PATCH: 리소스의 일부를 업데이트합니다.
3. HTTP 응답 상태 코드
요청이 서버에 어떻게 처리되었는지를 표현하는 상태 코드는 다양한 값이 있지만, 가장 중요한 몇 가지를 알아보겠습니다.
- 200: OK - 성공적으로 요청이 처리되었습니다.
- 201: Created - 새로운 리소스가 성공적으로 생성되었습니다.
- 400: Bad Request - 잘못된 요청이 전송되었습니다.
- 404: Not Found - 요청한 리소스를 찾을 수 없습니다.
- 500: Internal Server Error - 서버에 오류가 발생했습니다.
4. 필터링과 페이징
API에서는 결과를 필터링하거나 페이징할 수 있는 기능을 제공하는 것이 일반적입니다.
필터링은 URI 쿼리 매개변수를 사용하여 구현되며, 페이징은 "page"와 "limit" 매개변수를 사용하여 구현됩니다. 예를 들면, "/users?gender=male
'영역별 > Rule' 카테고리의 다른 글
| OAuth 1.0 vs 2.0 비교 (0) | 2023.11.20 |
|---|---|
| GraphQL에 대한 설명, 설치 방법, 사용하는 곳, 기본 사용 방법 (1) | 2023.11.19 |