긍정적 사고, 음식의 절제, 규칙적인 운동

REST API 제대로 알고 사용하기

meetup.toast.com/posts/92

목차

1. REST API의 탄생
2. REST 구성
3. REST 의 특징
4. REST API 디자인 가이드
5. HTTP 응답 상태 코드

REST는 Representational State Transfer라는 용어의 약자로서 2000년도에 로이 필딩 (Roy Fielding)의 박사학위 논문에서 최초로 소개되었습니다. 로이 필딩은 HTTP의 주요 저자 중 한 사람으로 그 당시 웹(HTTP) 설계의 우수성에 비해 제대로 사용되어지지 못하는 모습에 안타까워하며 웹의 장점을 최대한 활용할 수 있는 아키텍처로써 REST를 발표했다고 합니다.

REST 구성

쉽게 말해 REST API는 다음의 구성으로 이루어져있습니다. 자세한 내용은 밑에서 설명하도록 하겠습니다.

• 자원(RESOURCE) - URI
• 행위(Verb) - HTTP METHOD
• 표현(Representations)

REST 의 특징

1) Uniform (유니폼 인터페이스)

Uniform Interface는 URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일을 말합니다.

2) Stateless (무상태성)

REST는 무상태성 성격을 갖습니다. 다시 말해 작업을 위한 상태정보를 따로 저장하고 관리하지 않습니다. 세션 정보나 쿠키정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만을 단순히 처리하면 됩니다. 때문에 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해집니다.

3) Cacheable (캐시 가능)

REST의 가장 큰 특징 중 하나는 HTTP라는 기존 웹표준을 그대로 사용하기 때문에, 웹에서 사용하는 기존 인프라를 그대로 활용이 가능합니다. 따라서 HTTP가 가진 캐싱 기능이 적용 가능합니다. HTTP 프로토콜 표준에서 사용하는 Last-Modified태그나 E-Tag를 이용하면 캐싱 구현이 가능합니다.

4) Self-descriptiveness (자체 표현 구조)

REST의 또 다른 큰 특징 중 하나는 REST API 메시지만 보고도 이를 쉽게 이해 할 수 있는 자체 표현 구조로 되어 있다는 것입니다.

5) Client - Server 구조

REST 서버는 API 제공, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보)등을 직접 관리하는 구조로 각각의 역할이 확실히 구분되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어들게 됩니다.

6) 계층형 구조

REST 서버는 다중 계층으로 구성될 수 있으며 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고 PROXY, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있게 합니다.

REST API 디자인 가이드

REST API 설계 시 가장 중요한 항목은 다음의 2가지로 요약할 수 있습니다.

첫 번째, URI는 정보의 자원을 표현해야 한다.
두 번째, 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현한다.

           다른 것은 다 잊어도 위 내용은 꼭 기억하시길 바랍니다.

REST API 중심 규칙

1) URI는 정보의 자원을 표현해야 한다. (리소스명은 동사보다는 명사를 사용) GET /members/delete/1

위와 같은 방식은 REST를 제대로 적용하지 않은 URI입니다. URI는 자원을 표현하는데 중점을 두어야 합니다. delete와 같은 행위에 대한 표현이 들어가서는 안됩니다.

2) 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE 등)로 표현

위의 잘못 된 URI를 HTTP Method를 통해 수정해 보면

DELETE /members/1

으로 수정할 수 있겠습니다.
회원정보를 가져올 때는 GET, 회원 추가 시의 행위를 표현하고자 할 때는 POST METHOD를 사용하여 표현합니다.

회원정보를 가져오는 URI

GET /members/show/1 (x) GET /members/1 (o)

회원을 추가할 때

GET /members/insert/2 (x) - GET 메서드는 리소스 생성에 맞지 않습니다. POST /members/2 (o)

[참고]HTTP METHOD의 알맞은 역할
POST, GET, PUT, DELETE 이 4가지의 Method를 가지고 CRUD를 할 수 있습니다.

METHOD 역할

다음과 같은 식으로 URI는 자원을 표현하는 데에 집중하고 행위에 대한 정의는 HTTP METHOD를 통해 하는 것이 REST한 API를 설계하는 중심 규칙입니다.

URI 설계 시 주의할 점

1) 슬래시 구분자(/)는 계층 관계를 나타내는 데 사용

http://restapi.example.com/houses/apartments http://restapi.example.com/animals/mammals/whales

2) URI 마지막 문자로 슬래시(/)를 포함하지 않는다.

URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 합니다. REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않습니다.

http://restapi.example.com/houses/apartments/ (X)

http://restapi.example.com/houses/apartments (0)

3) 하이픈(-)은 URI 가독성을 높이는데 사용

URI를 쉽게 읽고 해석하기 위해, 불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높일 수 있습니다.

4) 밑줄(_)은 URI에 사용하지 않는다.

글꼴에 따라 다르긴 하지만 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 합니다. 이런 문제를 피하기 위해 밑줄 대신 하이픈(-)을 사용하는 것이 좋습니다.(가독성)

5) URI 경로에는 소문자가 적합하다.

URI 경로에 대문자 사용은 피하도록 해야 합니다. 대소문자에 따라 다른 리소스로 인식하게 되기 때문입니다. RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문이지요.

RFC 3986 is the URI (Unified Resource Identifier) Syntax document

6) 파일 확장자는 URI에 포함시키지 않는다.

http://restapi.example.com/members/soccer/345/photo.jpg (X)

REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않습니다. Accept header를 사용하도록 합시다.

GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg

리소스 간의 관계를 표현하는 방법

REST 리소스 간에는 연관 관계가 있을 수 있고, 이런 경우 다음과 같은 표현방법으로 사용합니다.

/리소스명/리소스 ID/관계가 있는 다른 리소스명

ex) GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)

만약에 관계명이 복잡하다면 이를 서브 리소스에 명시적으로 표현하는 방법이 있습니다. 예를 들어 사용자가 ‘좋아하는’ 디바이스 목록을 표현해야 할 경우 다음과 같은 형태로 사용될 수 있습니다.

GET : /users/{userid}/likes/devices (관계명이 애매하거나 구체적 표현이 필요할 때)

자원을 표현하는 Colllection과 Document

Collection과 Document에 대해 알면 URI 설계가 한 층 더 쉬워집니다. DOCUMENT는 단순히 문서로 이해해도 되고, 한 객체라고 이해하셔도 될 것 같습니다. 컬렉션은 문서들의 집합, 객체들의 집합이라고 생각하시면 이해하시는데 좀더 편하실 것 같습니다. 컬렉션과 도큐먼트는 모두 리소스라고 표현할 수 있으며 URI에 표현됩니다. 예를 살펴보도록 하겠습니다.

http:// restapi.example.com/sports/soccer

위 URI를 보시면 sports라는 컬렉션과 soccer라는 도큐먼트로 표현되고 있다고 생각하면 됩니다. 좀 더 예를 들어보자면

http:// restapi.example.com/sports/soccer/players/13

sports, players 컬렉션과 soccer, 13(13번인 선수)를 의미하는 도큐먼트로 URI가 이루어지게 됩니다. 여기서 중요한 점은 컬렉션은 복수로 사용하고 있다는 점입니다. 좀 더 직관적인 REST API를 위해서는 컬렉션과 도큐먼트를 사용할 때 단수 복수도 지켜준다면 좀 더 이해하기 쉬운 URI를 설계할 수 있습니다.

HTTP 응답 상태 코드

마지막으로 응답 상태코드를 간단히 살펴보도록 하겠습니다. 잘 설계된 REST API는 URI만 잘 설계된 것이 아닌 그 리소스에 대한 응답을 잘 내어주는 것까지 포함되어야 합니다. 정확한 응답의 상태코드만으로도 많은 정보를 전달할 수가 있기 때문에 응답의 상태코드 값을 명확히 돌려주는 것은 생각보다 중요한 일이 될 수도 있습니다. 혹시 200이나 4XX관련 특정 코드 정도만 사용하고 있다면 처리 상태에 대한 좀 더 명확한 상태코드 값을 사용할 수 있기를 권장하는 바입니다.
상태코드에 대해서는 몇 가지만 정리하도록 하겠습니다.

상태코드

상태코드

상태코드

화성에서 온 개발자, 금성에서 온 기획자

live.lge.co.kr/it_casting/

T 업계에 계시는 분들이라면 여러 프로젝트를 통해 다양한 캐릭터를 가진 기획자와 개발자들을 경험하셨을 겁니다. 기획자와 개발자는 ‘화성에서 온 남자 금성에서 온 여자’의 남자와 여자처럼 아주 가까운 대상이지만 때로는 서로 무슨 생각을 가지고 있는지 도저히 이해하기 힘든 대상이기도 합니다. 오늘은 제가 그들을 이해하기 위한 첫 번째 시간으로 기획자와 개발자에 있어 가장 중요한 역량에 대해 이야기 해 볼까 합니다.

기획자란 사전적 의미 그대로 ‘일을 꾀하여 계획하는 사람’입니다. 즉, 어떤 문제나 과제가 있다면 이를 파악하고, 분석한 뒤 실제 해결할 수 있는 방법과 실행을 위한 준비를 거쳐 결과물이 잘 만들어질 수 있도록 매개하는 사람입니다. 이에 반해 개발자란 ‘새로운 물건을 만들거나 새로운 생각을 내놓는 사람’이라는 의미로 어떤 과제가 주어지면 이를 실제 실행에 옮겨 결과물을 만들어내는 역할을 담당합니다.

즉, 기획자가 무엇을 만들 것인지 잘 설계하면 개발자는 그 결과물을 세상에 선보일 수 있도록 실현을 해주는 존재인 것입니다. IT 업계의 기획자와 개발자도 예외가 아닙니다. 어떤 제품 또는 서비스를 기획자가 기획하면, 실제 개발자는 고객이 사용하게 되는 제품 또는 서비스를 만들어주는 역할을 합니다.

이렇듯 서로 비슷한 듯 하면서 다른 두 그룹인 기획자와 개발자가 갖춰야 할 가장 중요한 역량이 무엇일까요? 저는 단연 ‘커뮤니케이션’을 이야기합니다. 다만, 기획자와 개발자가 집중하는 커뮤니케이션 대상이 다를 뿐인 것입니다. 기획자는 이해관계자들과 수 많은 커뮤니케이션을 하고, 개발자는 컴퓨터와 커뮤니케이션을 합니다. 이런 커뮤니케이션 능력이 바로 각자의 역할에서 얼마만큼의 성과를 낼 수 있는지의 중요한 지표가 되는 것이죠.

기획자는 다양한 이해관계자들과 여러 수준의 커뮤니케이션을 합니다. 이를 통해 그들이 꾀하는 일을 추진할 수 있도록 상대방을 설득하고, 때로는 개발자들과의 커뮤니케이션을 통해 원하는 결과물을 만들 수 있도록 설득합니다. 프레젠테이션 자료부터 프로젝트 개요까지 그들이 작성하는 모든 자료와 문서는 커뮤니케이션을 위해 사용된다고 해도 과언이 아닙니다. 다른 사람들에게 그들의 생각을 전하기 위한 과정인 것이지요.

반면 개발자는 주어진 목표와 일정 내에 결과물을 만들기 위해 그들만의 커뮤니케이션 방식인 프로그래밍 언어로 컴퓨터와 커뮤니케이션 합니다. 하루 일과 중 많은 시간을 일반인들이 이해하기 힘든 프로그래밍 코드를 작성하고, 컴퓨터와 대화를 주고 받는 과정을 통해 결과물을 만들어 가는 것입니다. 프로그래밍에 대한 지식이 없다면 무엇을 의미하는지 이해하기 힘든 것이 바로 프로그래밍 언어이지만 우리가 이야기하는 일상적 언어처럼 고유의 정해진 문법이 있고, 같은 결과물을 만드는 데에도 우리의 일상 언어처럼 표현방법이 무수히 많이 있습니다. 이를 얼마나 효과적으로 표현하고, 잘 다듬는지가 바로 개발자의 역량인 것입니다.

“멋진 서비스를 기획하여 오랜 시간을 설명하였는데 개발자가 나의 의도와는 전혀 다른 결과물을 만들어내는 상황을 경험하셨습니까?”, “분명 기획한 결과물대로 개발을 하였는데 만족스럽지 않다고 다시 개발해달라는 기획자가 이해되지 않으십니까?” 서로에 대해 오해하지 말고 각자가 중요하게 생각하는 커뮤니케이션 대상이 다르다는 것을 이해하고, 인정해 보시기 바랍니다. 그들에게는 커뮤니케이션 역량이 바로 능력을 보여주는 덕목이기 때문입니다.

이 세상의 수 많은 기획자와 개발자의 오해가 사라지는 그날을 위해…

개발자가 기획자를 쓸모 없다고 오해하는 이유

live.lge.co.kr/it_casting_3/

개발자들이 기획자에 대해 가지는 편견 중 하나가 바로 ‘기획자가 무엇을 하는지 모르겠다’는 것입니다. 실제 개발자 커뮤니티를 보면 기획자에 대한 불만의 글들을 종종 볼 수 있답니다. 기획자의 기획물이 개발자 본인이 생각하는 수준에 미치지 못한다 등 개발자 본인이 기획을 해도 훨씬 잘 만들 자신이 있다 등 다양한 의견을 볼 수 있습니다. 심지어 기획자들은 개발할 때 귀찮은 작업들을 대신해주는 사람들이라는 의견과 개발자 본인이 기획해도 훨씬 좋은 서비스를 만들 수 있다고 확신하는 개발자까지 있습니다.

이것이 바로 개발자들의 눈에 비춰진 기획자들의 모습입니다. 바로 ‘뜬구름 잡는 사람들 또는 귀찮은 일을 대신해 주는 사람들’이라는 것이죠. 오랜 기간 개발자 생활을 하였던 저도 왜 이런 생각을 하는지 공감하는 부분이 있습니다만 단순히 눈에 보이는 것이 기획 업무의 전부가 아니다라는 것을 제대로 이해하지 못해서 일어난 오해라고 생각합니다. 오늘은 이런 개발자들의 오해를 풀기 위해 기획자들의 기본적인 업무에 대해 소개하고자 합니다.

③ 개발자들이여, 기획자가 하는 일은 생각보다 많다

기획(企劃)은 한자로 ‘도모할 기’와 ‘그을 또는 계획할 획’의 조합으로 ‘계획을 도모하는 것’입니다. 그래서 영어로 기획을 Plan이라고 하지 않고, Planning이라고 합니다. 한 마디로 기획이란 ‘Why to do?’와 ‘What to do?’를 명확히 하는 것으로써 ‘왜 할 것인가?’와 ‘무엇을 할 것인가?’를 결정하는 것입니다. 이에 비해 계획은 ‘How to do?’ 즉, ‘어떻게 할 것인가?’를 정하는 것입니다. 왜 할 것인지를 결정하는 것이 기획이고, 어떻게 할 것인지를 생각하는 것이 계획입니다. 즉, 기획을 다시 한번 더 정의하면 기획자의 의도가 반영된 계획을 도모하는 일이라는 것입니다.

기획의 분야는 너무나 많습니다. 이 중 오늘은 개발자들과 함께 협업하는 분야인 서비스 기획(인터넷, 앱) 분야에 한정해서 기획자의 업무들에는 어떤 것들이 있는지 살펴보겠습니다. 서비스 기획이란 고객에게 웹과 앱을 통해 새로운 서비스를 제공하기 위해 기획하는 일입니다. 이를 위해 다음의 업무들에 참여하고, 내부 의사결정을 내립니다. 물론 회사의 규모에 따라 다음의 업무에 대한 절차와 복잡도는 줄어들 수도, 늘어날 수도 있습니다.

서비스 기획 업무

위 도표에서 보듯이 서비스 기획자는 크게 시장조사, 서비스 기획, 서비스 개발, 서비스 마케팅, 서비스 운영의 단계에 참여하게 됩니다. 많은 개발자들은 서비스 개발 단계의 서비스 기획 1차 이후의 단계에서 기획자들과 협업하지만 기획자들은 하나의 서비스를 만들기 위해 시장조사부터 전략 수립, 회사 내 의사결정 수렴 및 서비스 개발 이후의 단계까지도 많은 영역에서 다양한 부서의 담당자들과 함께 협업을 하고 있습니다. 물론 회사 규모가 작은 경우라면 한 두 사람이 모든 영역을 담당할 수도 있고, 또는 생략하는 경우도 있습니다만 해당 서비스가 커지고, 참여하는 사람이 많아지면 분명 각각의 단계가 서로 다른 사람들에 의해 진행되는 모습을 볼 수 있습니다.

서비스 기획을 단순히 서비스 기능을 정의하고, UI를 그린 후 개발자에게 넘기는 활동이라고 너무 좁게 생각하지 마시기 바랍니다. 물론 개발자들이 보는 결과물은 서비스 기획서, 요구사항 정의서가 전부인 것처럼 보이더라도 이런 결과물을 만들기 위해 내∙외부 조직들과 많은 커뮤니케이션과 협조를 끌어내는 것까지 숨어있는 활동이 많다는 것을 이해하면 좋겠습니다.

때로는 기획자들이 구현 불가능한 터무니 없는 기능을 개발해 달라고 해서 화가 나십니까? 비현실적인 일정과 이미 시장에 있는 다른 서비스와 유사하거나 또는 많은 서비스들의 장점을 마구잡이로 합쳐서 그저그런 서비스처럼 보입니까? 하지만 제대로 된 기획자라면 기획서 한 페이지, 기능 하나를 정의하더라도 이 서비스를 쓰게 되는 고객의 입장에서 어떤 가치와 어떤 영향력을 줄 것인지에 대해 많은 고민을 하고 있는 사람들입니다. 가끔은 그 결과물이 개발자의 눈에는 초라하게 보일지라도 기획자를 존중하고, 고객의 입장에서 서로 같은 방향을 두고 협업한다면 분명 의미 있는 서비스가 탄생할 것입니다. 성공적인 프로젝트, 성공적인 서비스를 위해 기획자의 업무를 조금 더 넓은 시각으로 이해해 보심이 어떨까요?

훌륭한 경쟁사보다 더 좋은 축복은 없다.
UPS와 페덱스의 경쟁 관계에서 볼 수 있듯이
훌륭한 경쟁사는 긴장의 끈을 놓지 않도록 해 준다.
누군가 쫓아오는 사람이 없으면 절대 발전할 수 없다.
- 톰 피터스, 경영 사상가


탁월한 경쟁자가 있다는 것은 개인이나 조직 모두에게 축복일 수 있습니다.
선의의 경쟁을 통해 시장을 키워나갈 수 있다는 측면에서도 그렇고,
긴장을 늦추지 않고 자신을 끝없이 채찍질할 수 있다는 점에서도 그렇습니다.
경쟁사 사장끼리 친하면 둘다 실적이 좋아진다는 최근의 연구결과도
경쟁자가 축복이 될 수 있다는 또 하나의 증거라 하겠습니다.

영혼 살인
4만 5011명.
지난 10년간
영혼을 '살해'당한 아이들의 숫자다.
지켜주지 못한 어른들이 미안해.


- 박지연의《안아줄게요》중에서 -


* 45,011명.
한 사람 한 사람이 고귀한 영혼입니다.
한 사람 한 사람이 우주의 중심입니다.
이 사회의 '어른들'의 깊은 성찰이 없으면
더 많은 어린 영혼이 사라지고
우주가 무너집니다.

PABX (private automatic branch exchange) ; 사설 자동 전화교환기

PABX[피에이비엑스]는 일반 기업 내에서 사용되는 자동 전화교환 시스템이다. 이전에도 각 기업에 사설 전화교환기가 있었지만, 그런 교환기의 운영을 위해서는 교환 업무를 담당하는 직원이 필요했었다. 그러나, 오늘날에는 거의 모든 사설교환기가 자동이기 때문에, "PBX"라는 약자가 곧 "PABX"를 의미하게 되었다.

• Macrotel은 ISDN 상에서 디지털과 아날로그 신호를 동시에 처리할 수 있는 PABX 시스템을 만드는 회사들 중의 하나입니다.
• Rolm의 홈페이지에서 자신들의 제품인 Rolm 9200 CBX에 대해 설명하고 있습니다.
• Usha의 홈페이지에서 자신들의 제품인 Coral EPABX에 대해 설명하고 있습니다.