RAML Design Best Practices


  • Raml file name should be in lower case and should be matched with the API functionality
  • It is always good to write the description and documentation about the functionality you are going to implement using the raml file
  • Specify the version number with the raml file
  • It is always best practice to create the raml fragments like Traits,ResourceType,SecuritySchemas and reuse the same in raml
  • Create the raml fragments and publish on exchange to share so that it can be reused throughout organization
  • Define the common error message schema with the error codes
  • Resource name inside the raml should always be in lower case and name should be noun
Thank you for taking out time to read the above post. Hope you found it useful. In case of any questions, feel free to comment below. Also, if you are keen on knowing about a specific topic, happy to explore your recommendations as well.
For any latest updates or posts on our website, you can follow us on LinkedIn. Look forward to connecting with you there.

Share this:
Notify of
1 Comment
Newest Most Voted
Inline Feedbacks
View all comments
Ankit Khedlekar
Ankit Khedlekar
1 year ago

Very Nice Explanation and the description is accurate!