Presentation on RAML at js-montreal (June 2015)

1. js-montreal - June 2015
presented by Jonathan Stoikovitch

2. > What is RAML?
Why RAML?
Practical example: API notebook
Practical example: e2e RAML application

3. 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

4. a RAML file

5. define anything, e.g. query params

6. resource type
schema
trait
trait, resource type, schema

7. 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

8. externalizable
inheritance
pull in traits
parametrize
Patterns: resource types

9. mix-ins
Patterns: method-level traits

10. or just use good ol'
form data:
XML schema
JSON schema
examples
Patterns: body schemas

11. What is RAML?
> Why RAML?
Practical example: API notebook
Practical example: e2e RAML application

12. Why RAML?
• Clean, simple, based on YAML
• Lots of tools: Client generators, Documentation
generators, Mock backend generators, API
Console & API Notebook

13. Why RAML?
Industry Backing

14. What is RAML?
Why RAML?
> Practical example: API notebook
Practical example: e2e RAML application

15. API Notebook
Example using RAML JavaScript client + Github API

16. What is RAML?
Why RAML?
Practical example: API notebook
> Practical example: e2e RAML application

17. e2e RAML application
Example using Ramses + RAML JavaScript client