DZone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Over 2 million developers have joined DZone.
Log In / Join
Refcards Trend Reports Events Over 2 million developers have joined DZone. Join Today! Thanks for visiting DZone today,
Edit Profile Manage Email Subscriptions Moderation Admin Console How to Post to DZone Article Submission Guidelines
View Profile
Sign Out
Refcards
Trend Reports
Events
Zones
Culture and Methodologies Agile Career Development Methodologies Team Management
Data Engineering AI/ML Big Data Data Databases IoT
Software Design and Architecture Cloud Architecture Containers Integration Microservices Performance Security
Coding Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Partner Zones AWS Cloud
by AWS Developer Relations
Culture and Methodologies
Agile Career Development Methodologies Team Management
Data Engineering
AI/ML Big Data Data Databases IoT
Software Design and Architecture
Cloud Architecture Containers Integration Microservices Performance Security
Coding
Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance
Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Partner Zones
AWS Cloud
by AWS Developer Relations
11 Monitoring and Observability Tools for 2023
Learn more
  1. DZone
  2. Data Engineering
  3. Databases
  4. RAML: Designing a Simple API

RAML: Designing a Simple API

In this tutorial, learn how to design a simple API by working with the RESTful API Modeling Language, complete with code and screenshots to illustrate the process.

Tirapa Reddy Tondapu user avatar by
Tirapa Reddy Tondapu
·
Apr. 26, 17 · Tutorial
Like (5)
Save
Tweet
Share
21.08K Views

Join the DZone community and get the full member experience.

Join For Free
  • The following procedure covers how to design and implement an online REST service and consume that service. The procedure describes an example API that has only one resource; for simplicity, the user details were hard-coded you can also implement a corresponding backend connection to get the actual user data based on the inputs.

Creating the Sample Project Name User_Information

Once you have started your Anypoint studio, click on File, New, and Mule Project as shown in the below screenshot:

Create a mule project

Enter the Project Name as `User_Information` and then click on Finish tab.

Project Folder Structure

Generating a Sample RAML Definition API (Creating sample.raml)

Right click on project (User_Information), click on New, click on RAML API Definition, and then enter the file name as "sample." Click on finish.

Creating Sample.raml file

As you can see in the below screenshot, a sample.raml file as been created with title "Sample AP."

Sample API

Configure a Service endpoint and document section using baseUri and documentation properties at the root level of RAML file, as shown in this screenshot:

Service Endpoint and documentation

baseUri: https://www.tirapareddy.com:8081/api

documentation:
- title: Home Page for Sample API
content: |
This example documentation forms part of a tutorial for a 
[RAML Turorial](https://docs.mulesoft.com/api-manager/design-raml-api-task) article.

Create a sample user-example.json response JSON file.

 {
"name":"Tirapa Reddy Tondapu",
"company":"Eidiko Systems Integrators",
"location":"Hyderabad"
}

Create a sample resource to get user details as shown in the below code block.

/userInfo/{id}:
  get:
  description: Retrieves details of a particular users
  responses:
    200:
      body:
        application/json:
          example: !include user-example.json


Now we have created a resource named "userInfo" that can be used to retrieve particular user information.

Generate Corresponding Flows for This Resource (userInfo) From the RAML File

In order to generate corresponding flows for the above userInfo resource we need to right click on sample.raml==> click on Mule ==> click on Generate flows from RAML as shown in the attached screenshot:Generating Flows

As you can see in the above screenshot once you click on "generate flows from RAML", it will generate sample.xml mule cofiguration file containing below items along with the  below attached HTTP listener  congiguration(i.e the application is running at hot "localhost" and post:8081)

  1. APIKit Router.

  2. APIKit Console.

  3. userInfo resource flow.

  4. Global exception strategy.HTTP Listener Configurations

Running The User_information Project

Right click on the project "User_information" then click "Run as" and then click on " Mule Application."

Once you click on "Mule Application," the project will be deployed as shown in the attached screenshot.

Deployed

As the project has been deployed, now it is accessible from http://localhost:8081/console once you browse this URL you will be able to see the below API details:

Sample API Console

You can now access the API resource "userInfo" by clicking on GET and the providing any id value as shown in the attached screenshot:

Final Output page of Sample API

You can also see entire source code at https://github.com/tirapa-eidiko/RAML_User_Information.

Thanks & Regards,

Tirapa Reddy Tondapu

API

Opinions expressed by DZone contributors are their own.

Popular on DZone

  • Container Security: Don't Let Your Guard Down
  • Unlock the Power of Terragrunt’s Hierarchy
  • Keep Your Application Secrets Secret
  • Journey to Event Driven, Part 1: Why Event-First Programming Changes Everything

Comments

Partner Resources

X

ABOUT US

  • About DZone
  • Send feedback
  • Careers
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • Become a Contributor
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 600 Park Offices Drive
  • Suite 300
  • Durham, NC 27709
  • support@dzone.com
  • +1 (919) 678-0300

Let's be friends: