Homepage
Open in app
Sign in
Get started
RAML by Example
Series of examples showcasing the power of RAML
Quick Starts
User Stories
Follow
RAML And OAS Support In API Console
RAML And OAS Support In API Console
Pawel Uchida-Psztyc
Jan 16, 2019
Using RAML inheritance to design better schemas
Using RAML inheritance to design better schemas
Consider an API resource that returns invoices in the form:
Jonathan Stoikovitch
Mar 9, 2018
How to describe properties as both optional and nullable in RAML?
How to describe properties as both optional and nullable in RAML?
Sometimes, I want my schemas to allow certain properties to be optional. This is how I can describe an object with two required and one…
Jonathan Stoikovitch
Mar 27, 2018
Modeling a JWT token
Modeling a JWT token
When designing APIs that return JWTs, I can use a RAML dataType pattern property to model a token, and thus validate its format:
Jonathan Stoikovitch
Apr 20, 2018
API Console version 6 is released
API Console version 6 is released
I am happy to announce new version of API Console is now available in stable release. It brings multiple changes and new tooling. Read…
Pawel Uchida-Psztyc
Jan 28, 2020
The future of SDKs for the web platform
The future of SDKs for the web platform
Recently at Chrome Dev Summit Gray Norton was talking about new proposal to web platform: the Layered APIs. It was a great talk about how…
Pawel Uchida-Psztyc
Nov 21, 2018
Using RAML-For-JAX-RS for Brewing (Part II): Building a better model
Using RAML-For-JAX-RS for Brewing (Part II): Building a better model
Welcome back!
JP Belanger
Jul 31, 2018
Conditional JSON properties (Part 2)
Conditional JSON properties (Part 2)
In Part 1, we covered several scenarios in which we defined sets of JSON properties that were either valid or invalid depending on the…
Jonathan Stoikovitch
Jul 26, 2018
Conditional JSON properties (Part 1)
Conditional JSON properties (Part 1)
One of the most important aspect of designing Web APIs is modeling its data layer. The data layer can take different shapes and it can be…
Jonathan Stoikovitch
Jul 18, 2018
raml-javascript-generator Quick Start
raml-javascript-generator Quick Start
raml-javascript-generator is a tool that generates JavaScript API clients from RAML API definitions. It takes a RAML file as input and…
Jonathan Stoikovitch
Jul 10, 2018
raml-cop Quick Start
raml-cop Quick Start
raml-cop is a command-line tool for validating RAML files. It supports both RAML 0.8 and 1.0. It can validate included files as well as…
Jonathan Stoikovitch
Jul 2, 2018
Using RAML-For-JAX-RS for Brewing (Part I)
Using RAML-For-JAX-RS for Brewing (Part I)
This is a tutorial on how to use raml-for-jaxrs to develop a real-life application. We will try to cover every aspect of application…
JP Belanger
Jun 30, 2018
oas-raml-converter Quick Start
oas-raml-converter Quick Start
This is an introduction to oas-raml-converter. oas-raml-converter is a command line tool that helps convert to and from RAML and OAS.
Jonathan Stoikovitch
Jun 26, 2018
raml2html Quick Start
raml2html Quick Start
raml2html is a documentation generator for RAML. It supports RAML 1.0. It provides both a CLI and a NodeJS library. It also supports custom…
Jonathan Stoikovitch
Jun 11, 2018
ramldt2jsonschema Quick Start (js2dt)
ramldt2jsonschema Quick Start (js2dt)
ramldt2jsonschema is both a CLI tool and a Library that can convert a RAML DataType to a JSON Schema, and vice-versa.
Jonathan Stoikovitch
Jun 8, 2018
Requiring query params
Requiring query params
Sometimes we need to require specific query parameters in URLs. There are different ways to go about it in RAML.
Jonathan Stoikovitch
Jun 6, 2018
ramldt2jsonschema v0.2.0 released 🎉
ramldt2jsonschema v0.2.0 released 🎉
If your workflow involves the use of JSON Schema to describe the payloads of your api, and ramldt2jsonschema's js2dt command to convert…
Jonathan Stoikovitch
May 17, 2018
osprey-mock-service v0.4.0 released 🚀
osprey-mock-service v0.4.0 released 🚀
osprey-mock-service v0.4.0 introduces a single improvment, but it is more significant than it seems.
Jonathan Stoikovitch
May 14, 2018
Quick mocks with osprey-mock-service
Quick mocks with osprey-mock-service
Perhaps the quickest way to turn a RAML file into a local mock service is to use osprey-mock-service. It’s simple to get started.
andrew toelle
Apr 12, 2018
Arrays in query params
Arrays in query params
The same way there is no concensus over how objects should be represented in query parameters, there is no standardized way to format…
Jonathan Stoikovitch
Apr 10, 2018
Modeling amounts in RAML
Modeling amounts in RAML
In JSON, values must be one of the following data types:
Jonathan Stoikovitch
Apr 5, 2018
osprey-mock-service v0.3.0 released 🚀
osprey-mock-service v0.3.0 released 🚀
A new version of osprey-mock-service -- v0.3.0 -- has been released today. This is a summary of the new features and improvments included…
Jonathan Stoikovitch
Apr 3, 2018
Osprey v0.5.0 released
Osprey v0.5.0 released
A new version of Osprey — v0.5.0 — has been released today.
Jonathan Stoikovitch
Apr 2, 2018
More concise syntax in raml2jsonschema v0.1.3
More concise syntax in raml2jsonschema v0.1.3
In v0.1.3 of ramldt2jsonschema(release notes), JSON documents are now processed into more concise RAML documents.
andrew toelle
Mar 20, 2018
About RAML by Example
Latest Stories
Archive
About Medium
Terms
Privacy
Teams