Upload
jonathan-stoikovitch
View
270
Download
1
Embed Size (px)
Citation preview
What is RAML?Stands for RESTful API Modeling Language
It's a way of describing APIs in a way that's highly readable by both humans and computers
It focuses on cleanly describing resources, methods, parameters, responses, media types, and other HTTP constructs that form the basis for modern APIs
Other solutions: Swagger, API Blueprint
optional version in baseUri
template URIs
query parameters
headers (on request and response)
response per status code
example (and schema) per media type
covers full HTTP
Why RAML?
• Clean, simple, based on YAML
• Lots of tools: Client generators, Documentation generators, Mock backend generators, API Console & API Notebook
API NotebookExample using RAML JavaScript client + Github API
e2e RAML applicationExample using Ramses + RAML JavaScript client