Mule raml
Download as PPTX, PDF0 likes614 views
RAML (RESTful API Modeling Language) is a simple way to describe RESTful APIs using a human-readable format. It facilitates the design-first approach to API development. The RAML file must be saved as "api.raml". The API Designer, API Console, and API Notebook tools can then be used to design, test, and document the API.
![RAML
• /songs:
• is: [ paged, secured ]
• get:
• queryParameters:
• genre:
• description: filter the songs by genre
• post:
• /{songId}:
• get:
• responses:
• 200:
• body:
• application/json:
• schema: |](https://image.slidesharecdn.com/muleraml-150527103457-lva1-app6891/85/Mule-raml-6-320.jpg)
![RAML
• schema: |
• { "$schema": "http://json-schema.org/schema",
• "type": "object",
• "description": "A canonical song",
• "properties": {
• "title": { "type": "string" },
• "artist": { "type": "string" }
• },
• "required": [ "title", "artist" ]
• }
• application/xml:
• delete:
• description: |
• This method will *delete* an **individual song**](https://image.slidesharecdn.com/muleraml-150527103457-lva1-app6891/85/Mule-raml-7-320.jpg)
Mule raml
- 1. Mule RAML RESTful API Modeling Language RESTful API Modeling Language (RAML) is a simple and succinct way of describing practically-RESTful APIs. RAML is the first standard facilitating the design-first approach to APIs . File must be saved as “api.raml”
- 2. API Designer • API providers can use the API Designer to easily create their API in a human-readable, easily consumable format, and then socialize that API definition with key stakeholders.
- 3. API Console • Both during and after the API design process, an API consumer can quickly and easily evaluate a RAML-documented API using the console, gaining a robust understanding of how the API actually behaves.
- 4. API Notebook • The API Notebook consumes RAML specs and produces a guided, object-oriented, in- browser JavaScript development experience which a developer would use to test real use- cases, build out proof-of-concept API mashups, and create shareable examples.
- 5. RAML Example File • #%RAML 0.8 • • title: World Music API • baseUri: http://example.api.com/{version} • version: v1 • traits: • - paged: • queryParameters: • pages: • description: The number of pages to return • type: number • - secured: !include http://raml-example.com/secured.yml
- 6. RAML • /songs: • is: [ paged, secured ] • get: • queryParameters: • genre: • description: filter the songs by genre • post: • /{songId}: • get: • responses: • 200: • body: • application/json: • schema: |
- 7. RAML • schema: | • { "$schema": "http://json-schema.org/schema", • "type": "object", • "description": "A canonical song", • "properties": { • "title": { "type": "string" }, • "artist": { "type": "string" } • }, • "required": [ "title", "artist" ] • } • application/xml: • delete: • description: | • This method will *delete* an **individual song**