RESTful Java Web Services - Third Edition

Overview of the RAML structure

Let's take a quick look at the RAML file structure, which describes the RESTful web services. An RAML file is a text file with the recommended extension of .raml. It uses spaces as indentation; you can use two or four spaces for indentation. The details of the content that you will find in a typical RAML file are as follows. We are grouping the contents into different logical sections to keep this discussion simple and easy to follow:

• Basic information: An RAML file starts with the basic information of the RESTful web APIs that you want to describe. This information is listed in the root portion of the document. The basic information includes information about REST APIs, such as the API title, version, base ...