사람

기업

게시물

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
박가람  소프트웨어 엔지니어 @파킹클라우드
소프트웨어아키텍처, devops, RESTful-api

블로그 글

채용 정보

4차 산업혁명 기반의 (반려)동물, (펫팸)사람, 환경의 One Health/Well-being Platform & Network : 전문가 기반 헬스케어 + 다가가는 IT 솔루션 융합을 통한 미병의 조기 관리 및 스마트 공유 헬스케어의 혁신 사업 분야 창출 

프로젝트

처방감사 서비스
 
2015년 7월 - 2016년 7월 
처방감사 서비스란 처방(의사) 및 조제(약사) 시 안전한 약물 사용을 위해서 점검하고 점검 결과를 이해당사자에게 제공함으로 의사결정에 도움을 주는 서비스이다. 이 서비스는 병원 평가인증제도 항목에 포함되어 필요한 서비스가 되었다. 그래서 이 서비스를 개발하기 위해 기획하고 경쟁사 및 심평원에서 제공하는 서비스를 분석을 통해 설계하고 구현 후 내부 테스트를 거쳐 2곳에 배포했다. 연동에 필요한 개발자 문서를 작성했다.
최동섭  분석/설계/개발 
810RP · mssql 상위 2%
복약지도 서비스 개선
 
2017년 6월 - 2017년 11월 
처방감사 업그레이드 작업에서 사용자 설정 기능 제공에 대한 만족도가 높았다. 사용자 요구사항이 가장 많았던 복약지도 형식에 대한 서비스 개선 작업을 진행하게 됐다. 사용자의 요구사항을 시스템 분석해서 설계하고 구현했다. 구현 작업 완료 후에 고객 서비스 안내 및 유지보수를 위해서 개발 명세서를 상세히 작성했다.
최동섭  분석/설계/개발 
810RP · mssql 상위 2%
드럭인포 플러스 심평원 DUR 서비스
 
2018년 1월 - 2018년 9월 
법적으로 처방(의사) 및 조제(약사) 시 의약품 안전사용에 대한 점검이 의무화됐다. 의약품 안전성과 관련된 정보를 실시간으로 제공하여 부적절한 약물사용을 사전에 점검할 수 있도록 한 시스템 구축을 심평원 DUR(의약품 안전 사용 서비스)이라고 한다. 드럭인포 플러스 통합에 심평원 DUR 서비스를 추가하기 위해 심평원에서 제공한 개발 가이드를 분석했다. 병원 및 약국, 심평원, 드럭인포 시스템이 서로 연동될 수 있도록 설계했다.
최동섭  분석/설계/개발 
810RP · mssql 상위 2%