아키텍처 의사결정 기록: REST API에 snake_case 대 camelCase?

결정: REST API 엔드포인트에는 snake_case 명명 규칙을 사용합니다

상태: 수락됨

맥락

REST API의 명명 규칙에는 snake_case와 camelCase라는 두 가지 인기 있는 형식이 있습니다. snake_case 형식은 이름의 각 단어를 밑줄로 구분하는 것이고, camelCase는 이름의 첫 단어는 소문자로 쓰고 이후 단어는 첫 글자를 대문자로 쓰는 것입니다. 이 결정은 REST API에 어떤 명명 규칙을 사용해야 하는지를 정합니다.

결정 동인

• 프로젝트의 기존 명명 규칙과의 일관성

• API 작업에 관여할 수 있는 모든 사람을 위한 가독성과 명확성

• REST API 명명 규칙에 대한 업계 모범 사례와의 정렬

• 구현과 유지보수의 용이성

결정

REST API 엔드포인트에는 snake_case 명명 규칙을 사용합니다. 이 선택은 다음 요인에 의해 이루어졌습니다:

1. 일관성: 프로젝트는 이미 모든 엔드포인트에 snake_case 명명 규칙을 사용하고 있으며, 이 규칙을 유지하는 것이 프로젝트 전체의 일관성을 보장하는 데 유익합니다.

2. 가독성과 명확성: snake_case 규칙은 더 읽기 쉽고 이해하기 쉽습니다. 밑줄이 단어 사이를 명확히 구분하여 이름의 의미를 파악하고 이해하기가 더 쉽습니다.

3. 업계 모범 사례와의 정렬: snake_case 규칙은 업계에서 널리 사용되며 REST API의 모범 사례로 간주되므로 프로젝트에 좋은 선택입니다.

4. 구현과 유지보수의 용이성: 기존 명명 규칙을 유지하는 것이 구현하고 유지보수하기가 더 쉽습니다. 새 규칙을 선택하면 모든 기존 코드와 문서를 갱신해야 하기 때문입니다.

결과

이 결정에는 잠재적인 결과가 있습니다.

• 프로젝트에 합류하는 새 팀원이 snake_case 명명 규칙에 익숙하지 않으면 개발 중 혼란과 실수로 이어질 수 있습니다. 그러나 snake_case는 널리 쓰이는 규칙이므로 그러한 위험은 최소입니다.

• camelCase 규칙에 크게 기반한 다른 도구나 프레임워크가 프로젝트에 사용되면 명명 규칙 간 변환에 추가 노력이 필요할 수 있습니다. 그러나 프로젝트가 snake_case 규칙으로 표준화했으므로 큰 우려는 아닙니다.

전반적으로 REST API 엔드포인트에 snake_case 명명 규칙을 사용하기로 한 결정은 일관되고, 읽기 쉽고, 업계 표준에 맞는 접근 방식을 가져오면서도 구현하고 유지보수하기 쉽습니다.

출처: 이 페이지는 ChatGPT가 생성한 뒤 명확성과 형식을 위해 편집되었습니다.