REST API 컨벤션 ❌ ⇒ 프론트와 협의 필요

• API 제공 방식 : REST
• 데이터 직렬화 : JSON

req

• URI

  • 기본적으로 리소스(도메인)에 따라 분류

  • 버전 관리

    api/{version}/{REST URL}
    

  • url에는 케밥케이스, path Variable에는 카멜케이스를 사용하자

    [GET] /system-orders/{orderId}
    

  • Collection에는 단수가 아닌 복수를 사용하자 (복수, 단수의 혼합 사용 지양)

  • 명사를 지향하지만 동사 사용도 허용한다.(ex. 리소스가 없는 작업)

  • 소문자 사용 권장

  • 필터링의 경우 새로운 url을 분리하기보다 쿼리 파라미터 사용하기

• Header
  • 인증 토큰은 URL이 아닌 Header에 넣어서 요청 (Authetication Bearer)

res

• Status Code

  200 OK
  201 Created
  204 No Content
  
  400 Bad Request
  401 Unauthorized
  403 Forbidden
  404 Not Found
  

  : 권한이 없는 사용자의 리소스에 접근시에는 403(Forbidden) 대신 404(Not Found) 사용

  HTTP response status codes - HTTP | MDN

• Error Message

  https://www.baeldung.com/rest-api-error-handling-best-practices

  

• Body

  • JSON property에는 카멜케이스(camelCase)를 사용하자

    {
         userId: "1"
       userName: "Covenant"
    }
    

• Header

  • post 메소드 사용시 location 헤더 추가하여 redirect

Reference