News Ticker

Version control your RAML specifications

file cabinets Photo by Element5 Digital on Pexels.com

Version controlling your RAML RESTful API specifications allow 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. For example, when you design an API with RAML you will specify examples in a RAML API specification to ensure that the specification provides the high level of documentation that a modern API should.

Leave a Reply

%d bloggers like this: