This document introduces APIs, REST APIs, and RAML. It defines an API as a set of definitions and protocols for building and integrating application software. REST APIs use HTTP requests to work with resources like GET and POST, and support multiple data formats including JSON. RAML makes it easy to design, manage, and deploy RESTful APIs through a YAML-based language that can be interacted with through a console without other tools. It provides a basic API structure automatically based on the RAML code.

1. Design REST APIs
using RAML
By: BHARGAV BALDEV
WWW.AIMDEK.COM

2. Agenda
• Introduction of API
• Introduction of REST API
• REST vs SOAP
• Introduction of RAML

3. Introduction of API

4. What is API?
• It stands for Application Programming Interface.
• An API is a set of definitions and protocols for building and integrating application software.
• It is a software intermediary that allows two applications to talk to each other.
• It establish communication path between two applications.
• APIs let your product or service communicate with other products and services without
having to know how they’re implemented.
• This can simplify app development, saving time and money.

5. Example
• Imagine you’re sitting at a table in a restaurant with a menu of choices to order from. The
kitchen is the part of the “system” that will prepare your order. What is missing is the
critical link to communicate your order to the kitchen and deliver your food back to your
table. That’s where the waiter or API comes in. The waiter is the messenger – or API – that
takes your request or order and tells the kitchen – the system – what to do. Then the waiter
delivers the response back to you; in this case, it is the food.
Restaurant (System)
Custome
r
Waiter(API)
Kitchen
Request (Order)
Request (Food)

6. Introduction of REST APIs

7. What is REST APIs?
• REST stands for REpresentational State Transfer.
• REST is a software architectural style for building applications that work over HTTP, often
web services.
• Web APIs that follows REST architectural constraints are called RESTful APIs.
• These APIs use HTTP requests to work with resources: GET, PUT, POST, DELETE, etc...
• It supports multiple formats for storing and exchanging data, such as plain text, HTML,
YAML, XML, and JSON.
• This is the reason why REST APIs are mostly used.

8. REST vs SOAP

11. Introduction of RAML

12. What is RAML?
• RAML stand for RESTful API Modeling Language.
• It makes easy to manage the API lifecycle from design to deployment.
• RAML is both machine and human readable; it’s written in the YAML format.
• You just need to write a code, it will automatically create a basic structure of API.
• It provides console and notebook to interact with that APIs, you don’t need any other tools
like postman to call it.

13. www.aimdek.com
AIMDek Technologies Pvt. Ltd.
+91 78747 88766 | +1 844-744-4423
Sales: sales@aimdek.com
General: hello@aimdek.com
AIMDek Technologies Inc.
+1 647-243-6116
Sales: sales@aimdek.com
General: hello@aimdek.com
AIMDek Technologies Inc.
+1 647-243-6116
Sales: sales@aimdek.com
General: hello@aimdek.com
www.aimdek.com www.aimdek.com
Canada India USA