본문 바로가기
카테고리 없음

좋은 API 설계하기

americano_people 2022. 7. 21. 21:55

규칙

  • 항상 사용자를 생각하기
    • 설명서 작성하기 (api docs)
    • 성공 / 실패 응답 모델을 모두 준비하기
  • 명사만 사용하기
    • 안티패턴 :
      • /get-user, /add-user
      • /delete-account
  • 명확하고 직관적인 이름 사용하기
    • 명확한 사례가 아니면 축약어 사용하지 않기
      • /identification-numbers보다는 /ids가 명확하다.
  • 소문자만 사용한다.
  • 단어는 -(하이픈)으로 구분한다.
  • 특수문자는 사용하지 않는다.
  • 파라미터는 카멜케이스를 사용한다.
  • API version을 제공한다.
    • /v1/account
    • 혹은 header parameter: X-API-VERSION

좋은 API 설계 사례

참조

저작자표시 비영리 변경금지

티스토리툴바