Naming Conventions

API endpoint Name

모든 API엔드포인트의 빠르고 쉬운 구별을 위해 HTTP 메서드 /경로...{파라미터} 형식이 아닌 영어 알파벳의 소문자와 대문자로만 이루어진 문자열 별칭을 부여합니다.

별칭을 부여할 때, 일관성을 위해 다음의 규칙을 사용합니다:

  1. 공백이 들어가는 경우 camelCase 를 사용해야 합니다.
  2. 같은 경로에 메서드만 다른 경우, 대상 X의 이름을 똑같이 사용합니다.
    1. 예: PATCH /post/{id} → updatePost, GET /post → getAllPost (O)
    2. DELETE /post/{id} → deleteReport (X) report말고 post를 사용해야 함.
  3. 의미를 가지는 영어 단어가 포함된 경우 동사 + 명사 순으로 배치되어야 합니다.
  4. 기존 엔드포인트의 경로와 메서드에 따라 다음 형식을 만족해야 합니다.
REST methods Meaning Format camelCase ver
GET /x x를 전부 조회 Get X getX
GET /x/{id} id에 해당하는 하나의 x만 조회 Get All X(복수형) getAllX
POST /x x를 생성 Create X createX
PATCH /x/{id} id에 해당하는 하나의 x만 변경 Update X updateX
DELETE /x/{id} id에 해당하는 하나의 x만 삭제 Delete X deleteX

단, 모든 경우가 이 규칙을 따라야 하는 것은 아니며 login 등의 특수한 경우라면 예외를 허용합니다.

View Name

뷰 이름도 엔드포인트 별칭과 같이 영문 대문자, 소문자로만 구성합니다.

뷰 이름은 엔드포인트에 비해 형식에서 자유로우며, 아래의 규칙만 만족하면 됩니다:

  1. 뷰 이름은 반드시 ~View로 끝나야 한다.
    1. 예: MapView, LoginView
  2. 공백이 들어가는 경우 PascalCase 를 사용해야 합니다.
    1. React의 컴포넌트, Android의 Layout, Flutter의 Widget 모두 PascalCase를 선호하기에 본 규칙을 따르길 권장합니다. 만약 사용하는 UI 프레임워크가 위 제시된 목록과 다른 경우 적절히 변환한 이름을 사용할 수도 있습니다. 단, 본 문서에서는 PascalCase로 강제합니다.