🏷️REST API 네이밍 검사기

Q: RESTful URL에 동사를 쓰면 안 되는 이유는 무엇인가요?

REST는 자원(리소스)을 명사로 표현하고 행위는 HTTP 메서드(GET, POST, PUT, DELETE)로 나타내는 방식입니다. URL에 getUser처럼 동사가 들어가면 메서드와 의미가 중복되어 설계 원칙에서 벗어납니다.

Q: 케밥 케이스(kebab-case)를 써야 하는 이유는 무엇인가요?

URL은 대소문자를 구분하는 시스템과 구분하지 않는 시스템이 혼재하고 있어 소문자와 하이픈(-)만 사용하는 케밥 케이스가 가장 안전하고 가독성이 좋은 표준으로 널리 쓰입니다.

API 엔드포인트 URL을 입력하면 RESTful 네이밍 원칙 준수 여부를 검사합니다.

API 엔드포인트 URL

REST API 네이밍, 왜 규칙이 중요할까?

REST API는 URL 구조 자체가 문서 역할을 겸합니다. 잘 설계된 엔드포인트는 별도 설명 없이도 "무엇을 다루는 자원인지"를 바로 알 수 있게 해주지만, 대소문자가 섞이거나 언더스코어와 동사가 뒤섞이면 협업 시 혼란이 커지고 클라이언트 코드에서도 예외 처리가 늘어납니다. 대표적인 RESTful 원칙은 자원을 명사(가능하면 복수형)로 표현하고, 행위는 HTTP 메서드(GET/POST/PUT/DELETE)로 구분하며, 소문자와 하이픈만 사용하는 케밥 케이스를 따르는 것입니다.

이 검사기는 입력한 엔드포인트 URL을 5가지 기준(소문자 사용, 케밥 케이스, 동사 미사용, 끝 슬래시, 파일 확장자)으로 자동 점검하고 100점 만점 점수와 등급을 알려줍니다. 새로운 API를 설계하거나 기존 API 문서를 리뷰할 때, 팀 컨벤션 문서를 만들기 전에 빠르게 점검하는 용도로 활용해보세요.

자주 묻는 질문

RESTful URL에 동사를 쓰면 안 되는 이유는 무엇인가요?

REST는 자원을 명사로, 행위는 HTTP 메서드로 표현하는 방식입니다. URL에 동사가 들어가면 메서드와 의미가 중복되어 설계 원칙에서 벗어납니다.

케밥 케이스(kebab-case)를 써야 하는 이유는 무엇인가요?

URL은 대소문자를 구분하는 시스템과 구분하지 않는 시스템이 혼재하기 때문에 소문자와 하이픈만 쓰는 케밥 케이스가 가장 안전하고 가독성이 좋습니다.

REST API 네이밍, 왜 규칙이 중요할까?

자주 묻는 질문

같은 카테고리 도구