RAML Example in Mule 4 | Basic RAML Example
RAML stands for RESTful API Modelling Language. We can make RAML for following purposes :
1. It is basically an API specification.
2. If API A is consumed by API B then it is standard contract between these two APIs.
3. It is also serves as API documentation.
4. We can mock or API by RAML.
5. We can generate API interfaces by using RAML.
Below is the example of a simple RAML API specification. This API is used to perform CRUD operations.
#%RAML 1.0
title: Employee API
version: v1
/person:
get:
description: get data of all persons
displayName: person
responses:
200:
body:
application/json:
example:
[{
"id" : 1,
"firstName" : "Rahul",
"lastName" : "Singh",
"city" : "Mumbai"
}]
post:
description: insert data of persons
displayName: person
responses:
201:
body:
application/json:
example:
{
"data" : "Data is inserted successfully"
}
put:
description: update data of persons
displayName: person
responses:
204:
body:
application/json:
example:
{
"data" : "Data is updated successfully"
}
delete:
description: delete data of persons
displayName: person
responses:
200:
body:
application/json:
example:
{
"data" : "Data is deleted successfully"
}
No comments:
Post a Comment