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
4
votes
2 answers

what is swagger exactly ? And why doesn't the online editor run requests?

I've spent the last few days trying to understand if I should use api blueprint, RAML or swagger. It looks like swagger has the biggest community but the closer I look the more I feel that it greatly lacks in documentation (I was forced to look at…
coiso
  • 7,151
  • 12
  • 44
  • 63
3
votes
1 answer

How can merge branch into master in MuleSoft (Anypoint design center)

We have created multiple RAML file in Design Center (Anypoint Platform - Mulesoft). We are working in team so multiple users can edit that RAML file by creating separate branch. Now I want to merge those branches into master branch. How can I do…
MohammedAshrafali
  • 499
  • 3
  • 8
  • 22
3
votes
3 answers

Does Swagger/RAML (or any similar REST API spec) supports REST asynchronous client callbacks?

I want to use REST async client callback, meaning the server is causing a callback operation to be invoked on the client side when a response is ready (see Jersey's 'Asynchronous Services and Clients' to get what I mean) Can I express this in…
Gilad Bar Orion
  • 543
  • 6
  • 14
3
votes
1 answer

How to define a map in RAML 1.0

I want to model an API with RAML 1.0. Within this API I have a map where the included objects have dynamic key values. It should look like the following: "map" : { "key1" : { ... } "key2" : { ... } "key3" : { ... …
Florian Stegmaier
  • 31
  • 1
  • 3
3
votes
2 answers

RAML 1.0 File Upload Definition

In the RAML tutorial found on the official page (http://raml.org/developers/raml-200-tutorial#body-parameters), a definition for a file upload looks like follows: /file-content: post: description: bla body: multipart/form-data: …
akohout
  • 1,802
  • 3
  • 23
  • 42
3
votes
1 answer

how to include common responses to raml resource

I have raml docs, and try to add new API's docs to that docs. I gone through basic RAML docs. I have raml file as. #Filename: base.raml title: Test RAML documentation: - title: Test RAML docs first time :) content: This is RAML…
Nilesh
  • 20,521
  • 16
  • 92
  • 148
3
votes
1 answer

What is the best approach to handle multiple security schemes in Mule flow using RAML?

I'm creating a webservice API using RAML. I've created RAML with two security schemes OAuth 2.0 Custom My first approach was to handle authorization on the basis of request parameter in which I was sending a special parameter inside my request…
Ankush Sharma
  • 65
  • 1
  • 11
3
votes
3 answers

RAML: how to export only particular type of XSD

I'm writing a RAML where response is an XML that corresponds to one particular type among many other types defined in an external XSD. Is there a way to specify the particular type name from the XSD when defining parameter in RAML? I.e. now I…
spoonboy
  • 2,570
  • 5
  • 32
  • 56
3
votes
2 answers

RAML default envelope

My API has a default envelope for all collection-type resources, like the following: { "data": [{},{},{}], "self": "http://api-url/members", "total": 120, "limit": 10, "offset": 0 } Is it possible to define this using RAML? Inside a…
stefanobaldo
  • 1,957
  • 6
  • 27
  • 40
3
votes
2 answers

RAML trait parameter default value

When defining a trait in RAML it's possible to parameterize it, e.g. traits: - searchable: queryParameters: query: description: Blah blah example: <> Has an <> parameter which is provided by a…
ivanhoe
  • 111
  • 1
  • 7
3
votes
5 answers

Invalid JSON Schema Error

I am using Mule EE 3.5.2 and migrating to 3.6.2. I have a RAML Project with a json schema thats throwing an error mule invalid JSON schema error: value has incorrect type (found boolean, expected one of [array]). On further digging I found that the…
hpandalai
  • 438
  • 2
  • 13
  • 31
3
votes
2 answers

Raml validator throws an error in javax.xml.validation.SchemaFactory.newSchema

When trying to validate espn.raml I got the below error. Same code is working fine for gmail.raml. Why is this happening? For your reference I have included the results I found what are the jars that SchemaFactory includes. $ find *.jar | xargs…
tk_
  • 16,415
  • 8
  • 80
  • 90
3
votes
1 answer

Write a file keeping tabs and EOL

I am trying to write the content of a string in a file in node.js I have some raml files and I am able to join them. If I print the variable in console, I see it well parsed but as soon as I save in on a file, the file just contains one single…
Biribu
  • 3,615
  • 13
  • 43
  • 79
3
votes
2 answers

Swagger2.0 to RAML conversion

I want to convert given Swagger 2.0 file to RAML. I used swagger2raml provided in https://github.com/8x8Cloud/swagger2raml which is not converting it. I also checked RESTLET but i don't know which API's to use. Can someone please help on this? I…
user3345282
  • 43
  • 1
  • 6
3
votes
2 answers

Multiple baseUri in RAML?

I am new to RAML and I have a basic question: It is not possible to specify a set of alternative baseUri (only a single is allowed). Is there any alternative way to model multiple alternative installations of an API (e.g. for separate release-cycle…
nize
  • 1,012
  • 1
  • 11
  • 27
1 2
3
…
24 25