Introduction to RESTful API Modeling Language (RAML)
Introduction to RESTful API Modeling Language (RAML) 1. Overview RAML is a YAML based language which is built on YAML1.2 and JSON for describing RESTful APIs. It provides all the information necessary to describe Restful API. It focuses on cleanly describing resources, methods, parameters, responses, media types, and other HTTP constructs that form the basis for modern APIs that obey many, though perhaps not all, Restful constraints. 2. Requirement Before jumping to RAML. Let’s assume we have to create one web application which is exposing CRUD Operations and couple of query parameters to access USER resources: · POST /api/v1/users · GET /api/v1/users · GET /api/v1/users?username={username} · GET /api/v1/users/{userId} · PUT /api/v1/users/userId{} · DELETE /api/v1/users/{userId} All the API’s are secured via Basic Authentication and all the communication will be done over HTTPS and all the request response will be in JSON format. 3. Implementation ...