Deep Dive into RAML

1. API Specification (RAML) Best Practices
2nd Sept 2023
Faridabad MuleSoft Meetup Group

2. Organizers
2

3. 3

4. ✔ MuleSoft Ambassador
✔ MuleSoft Meetup Speaker
✔ Guwahati & Lucknow Meetup Leader
✔ Certified MuleSoft Developer & Architect
✔ Total 8+ years of experience (6+ in MuleSoft)
✔ MuleSoft Industry & GTM Champion
✔ Solace | Dell Boomi | GCP Certifications
✔ Write technical Blogs and Create technical Videos.
✔ Own a Patent for developing a Portable Washing Machine.
Abhishek Bathwal
Apisero Inc
Associate Solution Architect
● About the Speaker
Introduction
linkedin.com/in/abhishek-bathwal-49360694
youtube.com/@abhishekbathwal1805
youtube.com/@developersguide5562 4

5. Safe Harbour Statement
● Both the speaker and the host are organizing this meet-up in individual capacity only. We are
not representing our companies here.
● This presentation is strictly for learning purposes only. Organizer/Presenter do not hold any
responsibility that same solution will work for your business requirements.
● This presentation is not meant for any promotional activities.
5

6. A recording of this meetup will be uploaded to events page within 24 hours.
Questions can be submitted/asked at any time in the Chat/Questions & Answers Tab.
Make it more Interactive!!!
Give us feedback! Rate this meetup session by filling feedback form at the end of the day.
We Love Feedbacks!!! Its Bread & Butter for Meetup.
Housekeeping
6

7. API Specification (RAML) Best Practices

8. 8
Agenda
● What is RAML?
● API Specification vs API Fragment
● Different Fragments type and their usage
○ Data Type
■ valid Email Address
■ valid Phone Number
■ Restriction on the number of digits after decimal point like #.00, #.000
○ Library
○ Security Scheme
○ Resource Type
○ Traits
● Best Practice
● Query String
● Different data types for same resource.
● Different data format for same resource.
● Strict Validation

9. 9
What is RAML?
RAML stands for RESTful API Modeling Language. It's a way of
describing practically-RESTful APIs in a way that's highly readable by
both humans and computers. We say "practically RESTful" because,
today in the real world, very few APIs today actually obey all constraints
of REST.
RAML lets you see what your API looks like as you design it, using easy
to read plain text. Without having to write a single line of code you can
not only perfect your API design, but also create a fully functional mock
for customers, partners, or even your own internal engineers to review
and build off of.

10. 10
API Specification vs API Fragments
An API fragment is a portion of an
API specification, which is why
understanding it starts at the API
specification level. An API spec
consists of a plan of how your
API should look structurally.

11. 11
Fragments we will discuss
● Data Type
● Library
● Security Scheme
● Resource Type
● Traits

12. 12
Best Practices
● Modularize or Fragmentation
● Naming standards Get Accounts Details
○ Kebab-case -> get-account-details
○ camelCase -> getAccountDetails
○ snake_case -> get_acounts_details
○ PascalCase -> GetAccountsDetails

13. 13
Strict Validation
Validating RAML on
application level.

14. Demo

15. References
https://raml.org/
https://www.apisero.com/combining-different-api-specifications-to-single-api-in-mule-4/
https://www.apisero.com/single-resource-having-different-data-format-and-data-type-in-raml/
https://apisero.com/strict-validations-in-mulesoft-apikit-router/
https://apisero.com/passing-at-least-one-mandatory-query-params-out-of-many-defined-in-raml/
15

16. Q&A

17. Take a stand !
17
● Nominate yourself for the next meetup speaker and suggest a topic as well.

18. Thank you