Stack Overflow
Stack Overflow

Questions tagged [raml]

RESTful API Modeling Language (RAML)

RESTful API Modeling Language (RAML, http://raml.org/) is a simple and succinct way of describing practically-RESTful APIs. It encourages reuse, enables discovery and pattern-sharing, and aims for merit-based emergence of best practices. The goal is to help our current API ecosystem by solving immediate problems and then encourage ever-better API patterns. RAML is built on broadly-used standards such as YAML and JSON and is a non-proprietary, vendor-neutral open spec.

RESTful API Modeling Language (RAML) makes it easy to manage the whole API lifecycle from design to sharing. It's concise - you only write what you need to define - and reusable. It is machine readable API design that is actually human friendly.

369 questions
68
votes
1 answer

RAML 1.0 representation of Java Map

I have RAML schema which contains "javaType": "java.util.Map>" I have separate schema (employee.schema) available which represent class Employee. But as I have not used employee.schema in RAML so it is not…
Yogesh Prajapati
  • 4,770
  • 2
  • 36
  • 77
45
votes
5 answers

Convert Swagger JSON to RAML/YAML

How do I convert Swagger JSON to RAML/YAML and validate it? I am not looking for a programmatic way, just a one off conversion.
helios
  • 2,603
  • 4
  • 21
  • 26
16
votes
4 answers

Good rest code generation and documentation tool

I have been considering a documentation tool for building a backend for a web service to be used in multiple clients along with OAuth and possibility of multiple revisions. I already knew about apiary but doing a little research I found other…
Pinser
  • 1,898
  • 3
  • 29
  • 43
14
votes
1 answer

How to use RAML to describe an API using OAuth2

I'm want to use RAML to describe an API using OAuth2 Does anyone have a solution or example I could use to compare with my own RAML for my api?
Nikos
  • 7,295
  • 7
  • 52
  • 88
12
votes
3 answers

Is there a Raml 1.0 (not 0.8) HTML generator?

Somebody knows if is there a version of raml2html to Raml 1.0? I found only tools for Raml 0.8, like raml2html or raml2md, but doesn't working for Raml 1.0.
Jessé Pinheiro
  • 303
  • 1
  • 3
  • 10
12
votes
2 answers

How to escape Special Characters in JSON

We have a form which has a long paragraph for a scienctific application that contains characters like symbol beta(ß-arrestin) etc. We have a JSON service running on Mule that takes the data and persists to an oracle database. This particular element…
hpandalai
  • 438
  • 2
  • 13
  • 31
10
votes
3 answers

How to override an object array property type in RAML 1.0

I have a generic Java type like this: class Response { List data; } and want to create something similar with RAML 1.0 (where I am new to). My first approach was types: Response: type: object properties: data: object[] and…
Arne Burmeister
  • 20,046
  • 8
  • 53
  • 94
9
votes
0 answers

RAML2HTML Templates Library

We recently decided to use RAML to document our API and all seems great so far. We are using the raml2html utility to generate static HTML documentation. The default template works great, but I've seen much better API pages. Does anyone know about…
Miroslav Nedyalkov
  • 1,101
  • 1
  • 10
  • 22
8
votes
1 answer

RAML definition reusable sub-route

Our api will have a reusable /posts subroute that will apply to different top-level routes. For example: /me/posts /users/{user-id}/posts ... Example for posts: /posts /{post-id} /likes /comments …
html_programmer
  • 18,126
  • 18
  • 85
  • 158
8
votes
3 answers

RAML : How to require parameter A OR parameter B

I'm writing some REST documentation with RAML but I'm stuck. My problem: - I have a GET request used for search that can take a parameter "id" or (exclusive or) "reference". Having only one of them is required. I know how to say "this param is…
firetonton
  • 324
  • 1
  • 3
  • 13
8
votes
2 answers

Dynamic population of example json in RAML

I am loving how RAML can dynamically reference different schemas when declaring a resourceType like: resourceTypes: - collection: get: responses: 200: body: application/json: …
Eric Olson
  • 2,827
  • 1
  • 20
  • 21
8
votes
1 answer

Is there eclipse plugin for RAML?

I would like to edit RAML on Eclipse. I didn´t found any Eclipse plugin to RAML. On RAML website (http://raml.org/projects.html) there is only to Sublime. Do you know an option to have a great experience writing RAML on Eclipse?
Rafael Leonhardt
  • 404
  • 5
  • 15
7
votes
2 answers

RAML 1.0 - Multiple Examples for a Single Response

I am unable to find any code anywhere that demonstrates using a !include for multiple examples. I'm trying to attempt the following: 200: description: Successful project creation body: application/json: type: JiraResponseSuccess …
Wheeler
  • 454
  • 5
  • 17
7
votes
0 answers

Possible for baseUri to be dynamic based on where raml was served

Just getting started with raml (read the spec) to see if it has what I need to document my api. Concerned about required baseUri property at root level to define you server Url. I am in a scenario in which my api is served out over many different…
lostintranslation
  • 23,756
  • 50
  • 159
  • 262
6
votes
3 answers

POST parameters support in RAML

I'd like to ask if there is any support for POST parameters in RAML. And if there is - what is the syntax. I've browsed spec 0.8 and spec 1.0 roughly (actually I'm bound to 0.8, since many tools don't support 1.0 yet). I didn't find POST parameters…
ducin
  • 25,621
  • 41
  • 157
  • 256
1
2 3
…
24 25