공통

DB에 데이터 삽입 시

모든 날짜 형식 데이터는 반드시 ISO 형식으로 삽입할 것. (매우 중요)

// javascript
const date = Date.now()

# python
from datetime import datetime, timedelta
date = datetime.utcnow().isoformat()

camelCase 사용
URL 설계 시
명사형으로 구성할 것
단어는 복수형을 사용할 것
단어를 구분할 땐 하이픈(-)을 사용할 것
파일 확장자를 되도록 포함시키지 말 것
- 리소스의 표현 형식(예: .json, .xml)을 URI에 포함시키기보다는 Accept 헤더를 통해 포맷을 지정
  HTTP Method
  
  GET
body 요소를 사용하지 말 것
멱등성을 가짐
POST
body 요소 사용 가능
멱등성을 가지지 않음.
PUT
body 요소 사용 가능
멱등성을 가지도록 구성할 것.
같은 요청을 반복해도 같은 결과가 되어야 함.
PATCH
body 요소를사용 가능
멱등성을 가지지 않음. 도큐먼트 혹은 레코드의 일부를 편집하고자 할 때 사용할 것.
DELETE
body 요소를 사용하지 말 것
삭제에 필요한 정보(id 등)를 URL에 포함시킬 것.
멱등성을 가짐
API 응답 형식 권장 사항

직관적인 JSON 응답 구조 사용

우리의 API는 최대한 간결하고 직관적으로 응답 구조를 제공하는 것을 목표로 합니다. 이를 위해, API 응답에서는 추가적인 래핑 객체 대신에, 필요한 데이터를 직접적으로 제공하는 방식을 선호합니다.

응답 데이터를 직접 포함하는 {} 형태를 사용하여, 클라이언트가 예상하는 데이터에 더 쉽게 접근할 수 있도록 합니다.

{
  "id": "12345",
  "name": "John Doe",
  "email": "john@example.com"
}

응답 데이터를 return과 같은 추가적인 키로 래핑하는 방식은 피해야 합니다. 이러한 방식은 데이터 접근에 불필요한 복잡성을 추가하며, 클라이언트 측에서 처리 과정을 더 복잡하게 만듭니다.

{
  "return": {
    "id": "12345",
    "name": "John Doe",
    "email": "john@example.com"
  }
}