REST API 작성 tip

[JuyeoungJun]

In GitLab by @gm2202981 on May 26, 2021, 17:23

Status Code

• 200 –> OK – Eyerything is working

• 201 –> OK – New resource has been created

• 204 –> OK – The resource was successfully deleted

• 304 –> Not Modified – The client can use cached data

• 400 –> Bad Request – The request was invalid or cannot be served. The exact error should be explained in the error payload. E.g. „The JSON is not valid“

• 401 –> Unauthorized – The request requires an user authentication

• 403 –> Forbidden – The server understood the request, but is refusing it or the access is not allowed.

• 404 –> Not found – There is no resource behind the URI.

• 422 –> Unprocessable Entity – Should be used if the server cannot process the enitity, e.g. if an image cannot be formatted or mandatory fields are missing in the payload.

• 500 – Internal Server Error – API developers should avoid this error. If an error occurs in the global catch blog, the stracktrace should be logged and not returned as response

참고자료

• https://multifrontgarden.tistory.com/252 [우리집앞마당]

Naming Convention

• 되도록 명사를 사용하라
  • document
    • 오브젝트 인스턴스나 데이터베이스 레코드
    • 단수형 명사
  • collection
    • 서버에서 관리하는 리소스 디렉토리
    • 복수형 명사
  • store
    • 클라이언트에서 관리하는 리소스 디렉토리
    • 단수형 명사
  • controller
    • 절차적 개념의 모델. 특정한 인자를 받고 값을 반환하는 함수.
    • 동사

참고자료

• https://restfulapi.net/resource-naming/
• https://support.smartbear.com/swaggerhub/docs/tutorials/openapi-3-tutorial.html

파라미터 타입

• query vs path
  • 하나를 식별하고 싶을 땐 path vs 정렬이나 필터링을 원할 땐 query

참고자료

• https://yuda.dev/250
• https://ryan-han.com/post/translated/pathvariable_queryparam/

[JuyeoungJun]

In GitLab by @gm2202981 on May 26, 2021, 17:27

changed the description

[JuyeoungJun]

In GitLab by @gm2202981 on May 26, 2021, 17:38

changed the description

[JuyeoungJun]

In GitLab by @gm2202981 on May 26, 2021, 17:56

changed the description