Can I include code examples in RAML documentation? - raml

Question

Is it possible to include code snippets in a RAML file, like examples of how to use each endpoint in different languages?
Ideally, something like this:
/account:
post:
description: Create an account
(snippets):
javascript: |
fetch('http://my-api/account', {method: 'post', body: ...})
.then(() => console.log('Success!'));
php: |
// whatever the php version of the above is
golang: |
// you know what I mean. Also, it'd be nice to get color coding for each language
body:
...

Answer 1

Maybe adding the text under the "documentation" is what you need. There you can simply add code snippets as well:
#%RAML 1.0
baseUri:
title: My API
version: v1.0
mediaType: [ application/json ]
protocols: [ HTTP, HTTPS ]
documentation:
- title: Introduction
content: |
This is a sample documentation. This API works like this:
Please see [Official documentation](https://My-URL) for more information
about the API.
```javascript
var raml2html = require('raml2html');
Some examples about how to query the REST API
// Comments if needed
```
- title: Chapter two
content: |
More content here. Including **bold** text!
Small table:
| A | B | C |
|---|---|---|
| 1 | 2 | 3 |
Done
types:
Error:
type: object
example: |
{
"code": 400,
"message": "Error occured while parsing Json"
}
properties:
code:
type: integer
description: The Error code
required: true
message:
type: string
description: The Error message
required: true