Restful API 모델링 언어 – RAML 이론 및 예제 실습

HYEONG HWAN, MUN/ 3월 19, 2015/ 미분류/

https://blog.lael.be/post/992

프로그래밍 언어도, 프레임워크도 어마어마하게 많다.

 

프로그래밍 언어도 주식과 같아서 미래에 유망할 언어를 일찍 배워두면 “선구자”가 되고 우러러 보이게 되지만

반대로 해당언어가 대세가 되지 못하고 망하면 노력이 물거품이 된다. 또는 다들 안쓰는데 혼자만 해당언어의 우수성을 논하면서 쓰면 이상한 사람 취급받는다.

 

라엘이가 최근에(지금도 역시) 서비스를 하나 만들고 있는데, 부분 기술이 확립이 되고, 서버 구성도가 나오고 나니, 중간에 시스템을 제어할 프로그램이 필요하게 되었고

이것을 위해서 API 를 만들어야했다.

 

API를 모델링 하기 위해서 나온 언어가 있나 확인해 보았는데, 역시나 있었다.

 

2015년 3월 현재 API Modeling Language 로는 3개 정도 있는데, 라엘이의 경우 RAML 을 선택하기로 했다.

라엘이가 3년넘게 마인크래프트라는 게임서버를 운영하고 있는데(이하 버킷서버),

버킷 서버 및 버킷 플러그인의 설정파일이 YAML로 짜여져 있어서 자주 손을 대었다.

 

따라서 YAML 을 확장해서 정의한 RAML 이 제가 사용하기 친숙하기 때문에 이 언어로 선택했습니다.

 

RAML의 약어는 Restful Api Modeling Language 입니다.

API를 정의하는 방식에도 여러가지가 있는데 대세의 흐름이

[일반 파일의 API] -> [SOAP 방식 API] -> [Restful API]

로 바뀌었다.

트위터, 페이스북, 네이버, 다음에서도 API 연동 시스템을 Restful 로 만들었다.

대세에 맞게

 

== 16.10.17 추가 ==

대충 RAML 작성Restful API 작성에 대한 예제 화면을 보여드립니다.

글로 자세히 설명하기 어려워서 작성이 많이 지연되었습니다. (또는 미완성 글로 남을 수도)

raml1

< RAML 작성예제 >

raml2

< RAML 을 API 로 표시한 화면 >

 

 

- 글 작성중입니다. -