사람

기업

게시물

REST API, URI 작명 어떻게 하지...? 마이크로 서비스 아키텍쳐(MSA)가 유행하면서 자연스럽게 서비스간 통신(커뮤니케이션)을 생각하게 되고 동기화가 크게 영향이 없다면 1순위로 생각하게 되는 건 다름 아닌 HTTP 기반의 API 일것이다. HTTP만 사용하면 REST API 라고 생각하는 개발자들도 종종 발견되는데, REST API 는 철저히 약속의 영역이다. 규칙이 존재한다는 뜻이다. 이 글에서는 REST API에서 명확게 정해지지 않아서 논쟁의 여지가 있는 URI에 대해서 이야기 해보려 한다. 우선 한줄 요약은 'dash-case' 로 작성해야 한다는 것이다. 작명 컨벤션 다양한 것들이 있다. - lowerCamelCase - UpperCamelCase - snake_case - dash-case 카멜 케이스는 자바 진영에서 많이 사용되고 스네이크 케이스는 데이터베이스를 기반으로 하는 몇몇 서버사이드 언어(PHP 등)들과 몇몇 스크립트 언어(python, 루비 등)가 사용하고 있다. 필자는 변수명에서 사용되지 않는 데시 케이스를 URI 작명으로 사용하자고 주장하는 이유는 다음과 같다. 첫번째, 일기 쉽다. 우리는 띄어쓰기를 사용하는 이유는 가독성이 좋기 때문이다. 위에 언급한 컨벤션을 가독성의 순서로 나열하면 dash case > snake case >> ... >> camel case 이다. 여러분이 자바 개발자라면 카멜 케이스는 가독성이 좋다고 주장할 수도 있다. 하지만 비개발자들 중에 파일명을 카멜케이스를 쓰는 사람은 거의 없을 것이다. 대부분 스네이크 케이스 혹은 데시 케이스다. 압도적으로 파일명은 데시케이스가 많다. 카멜케이스를 사용하는 개발자들도 제약사항이 없는 작명(프로젝트명, 문서)에서는 데시 케이스를 사용하는 경우가 종종 보인다. 데시 케이스는 본능적/학습적으로 가장 읽기 쉬운 케이스란 것임을 알 수 있다. 다음의 카멜케이스를 쉽게 읽기 어렵다. - ThisIsIllusion - ThisisIlilily 두번째, 스네이크 케이스는 혼선의 여지가 있다. URI 는 HTML에서 링크일 경우에 파란색 밑줄로 표현(스타일링)된다. 몇몇 문서 편집기도 이러한 규칙을 따른다. 그렇기 때문에 URI에는 밑줄을 사용 하면 혼선이 발생한다. API 스펙 문서에 URI가 있고 그것이 파란색 밑줄로 스타일링 되어있다면 실제 밑줄이라서 그런 것인지, 스타일링 때문에 그렇게 보이는지 알수 없게 된다. 세번째, REST API는 개발자들만 사용하는 것이 아니다. REST API를 json 형태를 리턴하는 API라고 오해하는 개발자들이 종종있다. 하지만 REST API는 다양한 표현을 전제한다. json, xml, html, csv 등등 다양한 표현 방식을 전제하는 API다. 일반 사용자들도 HTML 형식의 요청을 브라우저 주소창에 입력하여 직접 들어올 수도 있다. 그들은 앞서 언급한 것처럼 카멜 케이스에 배경지식이 전혀 없는 그룹일 가능성이 높다. REST API는 기본적으로 소통을 효율적으로 하기 위함인데 개발자의 전유물 처럼 사용하면 그것이 오른 방향인지 한번쯤 생각해봐야 할 것이다. 네번째 , URI 스키마와 호스트를 제외하고는 대소문자를 구분한다. 개발자들은 모든 시스템이 대소문자를 구별할 것이라고 착각한다. 하지만 그렇지 못한 시스템들도 존재한다. 혼선의 여지가 분명히 존재한다는 것이다. 다음의 URI를 살펴보자 - http://rest.api/thisIsMyPost - http://rest.api/thisismypost URI 스펙에서는 두 URI 값은 다른 것이라고 규정할 수 있다. 하지만 어떤 시스템에서는 두개의 차이를 구별 불가능 할 수 있다. 누군가는 대소문자만 구별하는 시스템만 사용하면 되지 않겠냐고 할 수 있겠지만, API를 만드는 이유는 API를 제공하는 서비스가 API를 제공받는 서비스를 직접 선택/제어 할 수 없다는 전제이다. API는 누구라도 사용할 수 있도록 정하는 것이 올바른 방향일 것이다. 결론 1. 카멜케이스는 읽기도 어렵고, URI 스펙에서 문제의 여지가 있을 수 있는데 사용하지 말자. 2. 혼선 있을수 있는 스네이크 케이스도 피하자. > 읽기도 쉽고 문제 소지가 적은 데시 케이스를 사용하자.
2019-03-14
박가람  소프트웨어 엔지니어 @파킹클라우드
246RP · Laravel framwork 상위 17%

블로그 글

채용 정보

구하다(GUHADA)
응답률 우수
'구하다(Guhada)'는 커뮤니티형 명품 및 디자이너 브랜드 전자상거래 플랫폼입니다. '구하다(Guhada)' 플랫폼에서는 블록체인 기술을 활용하여 소비자와 판매자 모두가 언제나 안심하고 명품을 거래할 수 있는 환경을 제공합니다. '구하다'는 블록체인 뿐만 아니라 상품, 검색 엔진, 커뮤니티, 토큰 결제 등 다양한 기술이 융합된 차별화된 플랫폼입니다. 

프로젝트

‘지옥철일 확률은?’
2019년 11월 | 진행중 
현재 진행 중인 프로젝트입니다 : - python을 사용하여 데이터 크롤링을 통해 지하철역별, 시간대별 승/하차 승객인원 및 각 노선별 한 시간 단위로 운행하는 전동차 수 추출 - 가공된 데이터를 토대로 사용자가 입력한 날짜, 역명에 따라 ‘지하철 혼잡도’를 계산해서 출력 - 깃헙 : https://github.com/iDaeun/Subway_Crawling
강다은  웹풀스택 개발자 
690RP · Java 상위 2%
앱개발. 웹개발. 퍼블리싱
 
2014년 12월 - 2018년 10월 
세일투나잇 에서 웹, 서버 개발을 담당 했습니다. 당일 땡처리된 호텔,모텔,숙박을 예약할수 있는 APP 입니다. 초반에는 개발자가 많았지만 회사 사정이 안좋아서 저혼자 약 2년정도 개발 및 운영 유지보수를 하였습니다. 주로 국내, 해외 API 연동 업무(java)를 하였으며 APP API 통신(php) 개발을 하였습니다. linux 서버에 mysql DB 를 사용 하였으며 solr(검색모듈)을 개발해서 사용하였습니다.
장용구  수원과학대학교 건축학과
480RP · Java 상위 5%
4세대 국종망 서비스 모듈
 
2016년 7월 - 2019년 5월 
브라우저의 액티브X 미지원 정책에 대응하기 위해 JAVA Swing을 이용한 관세청 EDI 송/수신 모듈 개발. - 기존 웹 브라우저에서 액티브X를 사용하여 dll 접근하는 방식의 지양에 따라 Java 라이브러리를 이용하여 dll을 호출하는 방식으로 개발 - 기존 웹방식에서 액티브X를 통한 내부진행사항이 사용자에게 시각적으로 표현하지 못하던 부분을 라이브러리를 통하여 자유롭게 dll에 접근이 가능해져 UI화 진행
최성천  서버/웹 개발자 
1350RP · Java 상위 1%