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
6
votes
1 answer

How to define an array of a type in an external file in Raml?

If I have a file defining a Datatype SimpleDuple, and in another file defining another datatype called DiscreetFilter I want to have a property values to be an array of SimpleDuple how would I use include there? Consider the files for…
David Pelaez
  • 1,374
  • 1
  • 13
  • 16
6
votes
1 answer

Describing URI parameters in RAML

I'm declaring a REST service API stub in RAML. My web application provides equipment, which can be listed, obtained by id or by code. When I want the whole list, I don't specify any URI parameter, however, to get a concrete equipment, I do. That's…
Aritz
  • 30,971
  • 16
  • 136
  • 217
5
votes
1 answer

Osprey RAML Validation Error Handling

I am trying to custom handle response sent to caller due to RAML specification failure. At the moment my code does the following. const cfg = require("./cfg"); const log = require('./logging'); const RAML = require('osprey'); const startMessage =…
user2085689
  • 336
  • 3
  • 17
5
votes
2 answers

Is the way to exclude property from body type (RAML)?

Is there a way to exclude one or more properties from a request body when you use a type and writing your API using RAML 1.0 I'll explain. I have a type: 'Order' with a set of properties. I have a resource /orders and a method post which allows…
Anton Ivanov
  • 199
  • 1
  • 11
5
votes
4 answers

splitting swagger definition across many files

Question: how can I split swagger definition across files? What are the possibilities in that area? The question details are described below: example of what I want - in RAML I do have experience in RAML and what I do is, for example: /settings: …
ducin
  • 25,621
  • 41
  • 157
  • 256
5
votes
1 answer

Facebook API in machine readable format

Where I can find the Facebook API in a format like http://swagger.io, https://apiblueprint.org or http://raml.org? I want to read and request the facebook server (api) "half-atomatic". My script knowns how to interact with the facebook server. And…
Tobias Oberrauch
  • 217
  • 6
  • 15
5
votes
3 answers

RAML: Nested Schemas

1) When writing RAML, can I use nesting in my schema definition? For example: schemas: - DNSResponse: | { "type": "object", "properties": { "AnswerSection": { "type": "array", …
KFunk
  • 2,956
  • 22
  • 33
5
votes
2 answers

API Kit Router schema validation

Is there a way to have the API Kit Router validate incoming schema? I have the following in my RAML file but it does not validate the incoming schema. - emails: | { "$schema": "http://json-schema.org/draft-04/schema#", "type"…
SteveS
  • 1,008
  • 3
  • 18
  • 32
4
votes
0 answers

How to get ResponseType from openapi 3

We are currently migrating some old rest interfaces from RAML to OpenAPI 3. In the RAML file an HTTP delete operation has the response defined with empty body as follows: delete: responses: 204: This generates java-code with a delete method…
ladonyim
  • 41
  • 1
4
votes
2 answers

Auto generate REST api documentation into RAML from Spring MVC controllers

I am new to Spring-Boot. I want to auto generate my REST api documentation into RAML from my Spring MVC controllers. Is there anything to do that? or any guide that I could use it for generating my rest api into RAML?
user6941415
4
votes
1 answer

Documenting message based API in Swagger or RAML

How do we document a message based API in Swagger or RAML ? By message based I mean that the endpoint is always the same, but one can send multiple message types to this endpoint and depending on the type of input message we get different…
Luis Trigueiros
  • 636
  • 7
  • 21
4
votes
4 answers

Intellij IDEA Plugin for RAML

I have just started using RAML in my Java project. I am using Intellij IDEA and there my RAML file is displayed as raw text, without any text highlighting. It seems that it doesn't recognize this type of file at all. Is there any plugin for RAML in…
Rufi
  • 2,529
  • 1
  • 20
  • 41
4
votes
1 answer

Dropwizard + Raml -> empty resource

When I start the server there is a warning which says that my resource is empty (which results in a 404): WARN org.glassfish.jersey.internal.Errors - The following warnings have been detected: WARNING: A resource, Resource{"helloz", 0 child…
KIC
  • 5,887
  • 7
  • 58
  • 98
4
votes
0 answers

RAML file for OAuth 2.0 spec itsetlf (not an API using OAuth)

Is there a RAML file for the OAuth spec itself? I am seeing lots of examples of APIs defined in RAML that use OAuth, but I am curious if there is one that would define an OAuth Authorization server itself.
user3294980
  • 41
  • 1
4
votes
1 answer

Is it possible to import and/or export API Blueprint to/from Swagger and/or RAML?

Is it possible to bridge between any of the formats? Thank you.
jim
  • 41
  • 2
1
2
3
…
24 25