Enterprise Java

Version control your RAML specifications

Version controlling your RAML RESTful API specifications allows you to continue maintaining previous version of your APIs.

The API designer from MuleSoft has a build in version control feature that supports simple branching from the master.

RAML API Branching Workflow

  • Version the API specification and select the down arrow from the master branch and enter a version number.
  • Click the + button to create the new branch.
  • Switch back to the master branch to continue designing the API. Add further branches for each version you want to control.
  • Now that the API specification is controlled for each version you can switch between versions and make necessary maintenance chances and publish to exchange.

Five principles of RESTful API Design

There are five principal aspects to a RESTful API specification that must be considered prior to coding an API specification. Learn more with RESTful API Design.

Published on Java Code Geeks with permission by Alex Theedom, partner at our JCG program. See the original article here: Version control your RAML specifications

Opinions expressed by Java Code Geeks contributors are their own.

Alex Theedom

Alex Theedom is a Senior Java Developer and has recently played a pivotal role in the architectural design and development of a microservice based, custom built lottery and instant win game platform. Alex has experience of Java web application development in a diverse range of fields including finance, e-learning, lottery and software development. He is the co-author of Professional Java EE Design Patterns and many articles.
Notify of

This site uses Akismet to reduce spam. Learn how your comment data is processed.

Inline Feedbacks
View all comments
Back to top button