Over a million developers have joined DZone.

Writing Your First RAML on Anypoint Platform

DZone's Guide to

Writing Your First RAML on Anypoint Platform

It only takes ten steps to run a RAML API definition on the Anypoint Platform.

· Integration Zone
Free Resource

Share, secure, distribute, control, and monetize your APIs with the platform built with performance, time-to-value, and growth in mind. Free 90-day trial of 3Scale by Red Hat

As we know, the development process happens in two phases: the design phase and the development phase. In the design phase, we design the API with API Designer and give it to the user for testing, and let the actual code get ready later to meet the spec. Let's get started.

1. Sign up for the Anypoint Platform.

Image title

2. Find the API Manager link.

Image title

3. The below page will appear. Click on the link that I've highlighted.

Image title

4. Click on Add New API to get started.

Image title

5. Provide the API name and the Version name.

Image title

6. The page will show Project explorer, Editor, Shelf, and the API Console.

Image title

7. Rename the existing RAML file based on your requirements.

Image title

8. The RAML code for the Customer API is the resource customer, which has methods like Get Customer and Get Customer by ID.

Image title

9. Activate the mocking service.

Image title

10. To run the RAML API definition, click on GET on the API Console. The following response will be shown.

Image title

And that's it!

Explore the core elements of owning an API strategy and best practices for effective API programs. Download the API Owner's Manual, brought to you by 3Scale by Red Hat

raml ,anypoint ,tutorial ,integration ,api

Opinions expressed by DZone contributors are their own.


Dev Resources & Solutions Straight to Your Inbox

Thanks for subscribing!

Awesome! Check your inbox to verify your email so you can start receiving the latest in tech news and resources.


{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}