人类可读的raml语法
开始设计时,首先创建一个包含以下内容的RAML文件:
#%RAML 0.8
title: This is My API
baseUri: http://api.domain.com
version: 1
在以上代码中,我们首先声明这是一个RAML规范,它对应RAML 0.8,并声明API的标题、基本URI、以及这个API的版本号。
在RAML中声明资源非常简单,只需使用/resourceName格式。而添加方法也同样便捷,只需引用相应的HTTP谓词即可:
#%RAML 0.8
title: This is My API
baseUri: http://api.domain.com
version: 1
/resource1:
get:
description: This gets the collection of resource1
post:
description: This adds a new item to the collection
RAML让你能够定义多种相应,返回不同的状态码、头信息以及响应体。例如:
#%RAML 0.8
title: This is My API
baseUri: http://api.domain.com
version: 1
/resource1:
get:
responses:
200:
headers:
cache-control:
example: |
public, no-cache, no-store
body:
application/json:
example: |
{"