프로젝트를 나가면 SPM문서가 보통 존재합니다. 그 문서 안에는 개발을 하는 여러가지 방법들과 표준들이 서술되어 있습니다. 그와 비슷하게 guideline 같은 문서들이 존재 하는데 오늘 소개해 드릴 깃헙 프로젝트는 MS에서 내 놓은 REST API 가이드라인입니다.
2016/07/20 Editor’s choice
Microsoft/api-guidelines
_api-guidelines - Microsoft REST API Guidelines_github.com
Airbnb말고는 가이드라인에 관한 문서는 크게 소개해 드린 적은 없었던 거 같은데, MS의 API 가이드라인을 소개할 날이 올 줄은 몰랐네요.
중요한 내용 위주로 훑어보도록 하겠습니다.
시작은 Microsoft Cloud Platform에 대한 이야기 부터 시작합니다. 클라우드 플랫폼을 많이 쓰는데, REST API를 많이 쓰고 있으니 표준을 잡겠다고 시작을 합니다.
API작성을 위한 추천할 만한 링크를 소개하는데
http://www.ietf.org/rfc/rfc2616.txt
REST API spec 과 아마존의 추천서 하나
REST in Practice: Hypermedia and Systems Architecture
_Edit description_www.amazon.com
그리고 Wikipedia의 링크
Representational state transfer
_”REST” redirects here. For other uses, see Rest. In computing, representational state transfer ( REST) is an…_en.wikipedia.org
7장 이 Guide line의 본격적인 시작이라고 보여지는데 URL구조부터 시작하는군요
Humans SHOULD be able to easily read and construct URLs.
사람이 읽기 좋은 URL을 가져야한다는 군요.
좋은 예는
https://api.contoso.com/v1.0/people/jdoe@contoso.com/inbox
나쁜 예는
https://api.contoso.com/EWS/OData/Users('jdoe@microsoft.com')/Folders('AAMkADdiYzI1MjUzLTk4MjQtNDQ1Yy05YjJkLWNlMzMzYmIzNTY0MwAuAAAAAACzMsPHYH6HQoSwfdpDx-2bAQCXhUk6PC1dS7AERFluCgBfAAABo58UAAA=')
REST API는 다음과 같은 VERB를 가진다로 표현을 하는군요
PATCH와 OPTIONS는 생소하네요.
일종의 REST API백서라고 볼 수 있는데, 아주 상세하게 표현이 되어 있습니다.
By Keen Dev on July 20, 2016.
Exported from Medium on May 31, 2017.
하루종일 본 짤.