API Specifications and Best Practices | MuleSoft Mysore Meetup #4 What is RAML? API Specification vs. API Fragment Various Fragment types and their usage Speaker:- Abhishek Bathwal Organizers:- Shubham Chaurasia, Giridhar Meka

1. October 22, 2022 11:00 am IST
Mysore MuleSoft Meetup
Fundamentals of RAML

2. 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.
2

3. 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!!!
Housekeeping
3

4. 4
• Introduction
• RAML
- What is RAML?
- API Specification vs API Fragment
- Different Fragment types and their usage
o Traits
o Library
o Data Type
o Resource Type
o Security Scheme
- Best Practices
• Trivia
• Wrap-up
Agenda

5. Introduction
• About the Organizers
Giridhar Meka
HashedIn
Sr. Technical Architect
5
Shubham Chaurasia
Billennium India
Professional Integration Developer
A SHOW OF HANDS:
Who is new to this Meetup?

7. Introduction
Abhishek Bathwal
Apisero Inc.
Associate Solution Architect
 MuleSoft Ambassador
 MuleSoft Meetup Speaker
 Guwahati & Lucknow Meetup Leader
 Certified MuleSoft Developer and Architect
 7+ years of Total Experience, 5+ years in MuleSoft
 Working as Associate Solution Architect at Apisero Inc.
• About the Speaker:

8. Fundamentals of RAML
API Specification

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 Fragment
- 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
Let’s go over the Fragments
• Traits
• Library
• Data Type
• Resource Type
• Security Scheme

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

13. Demo

14. Q&A

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

16. Get ready to WIN a Special Gift from MuleSoft Community
Quiz Time

17. 17
● Share:
○ Tweet using the hashtag #MuleSoftMeetups
○ Invite your network to join: https://meetups.mulesoft.com/mysore/
● Feedback:
○ Fill out the survey feedback and suggest topics for upcoming events
○ Contact MuleSoft at meetups@mulesoft.com for ways to improve the program
What’s next?

18. Thank you