RAML là từ viết tắt của RESTful API Modeling Language. Đây là một phương pháp mô tả API trong thực tiễn theo một cách rất dễ đọc cho cả máy lẫn người. API trong thực tiễn ở đây phân biệt với API theo chuẩn REST, là bở vì thực tế hiện nay có rất ít các API tuân thủ hoàn toàn theo chuẩn REST.
RAML là gì?
RAML là từ viết tắt của RESTful API Modeling Language. Đây là một phương pháp mô tả API trong thực tiễn theo một cách rất dễ đọc cho cả máy lẫn người. API trong thực tiễn ở đây phân biệt với API theo chuẩn REST, là bở vì thực tế hiện nay có rất ít các API tuân thủ hoàn toàn theo chuẩn REST.
RAML không cứng nhắc mà tập trung vào việc mô tả resources, methods, tham số (parameters), responses, media types, và những cấu trúc HTTP khác một cách sáng sủa rõ ràng mà vẫn tuân theo hầu hết các tiêu chuẩn của REST.
Ngoài ra, RAML là một spec mở, không thuộc sở hữu bởi một cá thể nào. Được sinh ra để giúp việc mô tả API trở nên tốt hơn, thống nhất hơn.
Các đặc trưng của RAML
- Sáng sủa: Cấu trúc của API rất tường minh. Các pattern được đưa lên hàng đầu. Dữ liệu và tương tác được đặt ở trung tâm.
- Chính xác: Mô tả API được phản ánh chính xác lên API kết quả. Bất cứ khai báo nào nếu có trong mô tả đều trở thành thuộc tính của API.
- Tỉ mỉ, nghiêm ngặt
- Nhất quán: RAML rất mạnh trong việc bắt chước các pattern. RAML giúp tăng cường việc chia sẻ, sử dụng lại các pattern
- Dễ đọc và viết: Được tối ưu để dễ đọc và tạo bởi ngay cả những người thiếu kiên nhẫn và thông minh :p
- Tự nhiên và trực quan: Cách viết rất tự nhiên theo suy nghĩ thông thường. Cứ như bạn đang soạn một email cho một người bạn hướng dẫn thiết kế hoặc sử dụng API vậy.
