API 설계 규칙

아래 원칙을 따르되 이해관계자가 최대한 이해할 수 있는 방식으로 API를 설계한다.

• 모든 경로는 kebab-case로 작성한다. (e.g. /api/application-forms)
• 엔티티를 나타내는 구문은 복수형으로 작성한다. (e.g. /api/recruiments)
• 경로 변수는 식별자만 허용한다. (e.g. /api/recruiments/1)
  • 조회 조건을 경로 변수에 넣으면 특수 문자가 들어왔을 때 오작동하기 쉽다.
  • 같은 자료형의 조회 조건을 2개 이상 만들 때 혼란이 발생한다.
• 요청 메서드로는 잘 설명되지 않거나 명시적으로 수행하려는 경우 동사를 뒤에 붙인다. (e.g. /api/recruitments/{recruitmentId}/evaluations/{evaluationId}/targets/renew)
• 부모-자식 관계가 헷갈릴 때 부모 없이 자식을 지칭하는 것이 가능한지 생각해 본다.
  • 부모를 통해 자식을 지칭하거나, 부모 없이 자식을 지칭할 수 있다면 두 가지 방법을 모두 설계할 수 있다.