Raml basic tutorial

1. RAML BASIC INFORMATION
By
Arun Yaligar

2. Data Models
complex schemas and examples become simply typed models that can be
used for code generation, clear interpretation, example generation, and
yes – even multi-formatschema generation.
OR

3. DATA
MODELS
• data models are easily pulled in to
other models, used as schemas/
examples, and can even be stored
in libraries and namespaced!

4. LIBRARIES
RESOURCETYPES, TRAITS, SCHEMAS, EXAMPLES, DATA
TYPES (MODELS), AND MORE CAN ALL BE STORED IN
LIBRARIES, WHICH CAN THEN BE PULLED INTO THE
RAML SPEC IN A NAMESPACED FORMAT – LETTING
YOU REUSE WHAT YOU WANT, AND IGNORE WHAT YOU
DON’T.

5. OVERLAYS
YOUR API DOESN’T JUST LIVE IN ONE
ENVIRONMENT, SO NEITHER SHOULD YOUR
DESIGN, DOCUMENTATION, OR TESTS. OVERLAYS
LET YOU “EXTEND” YOUR RAML SPEC FOR YOUR
DEVELOPMENT, QA, AND PRODUCTION
ENVIRONMENTS.
Original Spec Overlay setting Production Values

6. ANNOTATIONS
VENDOR EXTENSIONS SHOULDN’T BE A PAIN, AND IN
RAML – THEY’RE JUST “NEW” PROPERTIES IN YOUR
SPEC.
Plus you can use libraries
and overlays to keep
annotations separate
from your main spec,
meaning they are only
visible to the vendor you
want using them, and
out of the way of your
developers/ tech
writers/ CEO!

7. API WORKBENCH
A BRAND NEW IDE TO DESIGN APIS ONLINE AND
OFFLINE, BUILT ON TOP OF GITHUB’S ATOM PROJECT,
MEANING COLLABORATION AND VERSIONING HAVE
NEVER BEEN EASIER! FINALLY, A TOOL FOR
DEVELOPERS TO DESIGN APIS WITH!

8. AND A BRAND NEW SITE +
PROJECT DIRECTORY

11. PROJECTS VIEWED
OVER 17,000 EVERY
DAY!!!

12. RAML.ORG
APIWORKBENC
H.COM
@ramlapi