Import RAML vào Postman

684

Bài viết được sự cho phép của tác giả Nguyễn Hữu Khanh

Sau khi định nghĩa API specs bằng RAML file, chúng ta có thể generate code để implement những API này sử dụng Spring framework và cũng có thể import nó vào Postman để thực hiện việc testing. Trong bài viết này, mình hướng dẫn các bạn cách import RAML vào Postman các bạn nhé!

Chạy Postgresql trong Docker container

Định nghĩa request body và response với RAML

Xem thêm việc làm PostgreSQL hấp dẫn trên TopDev

Mình sẽ sử dụng tập tin RAML định nghĩa các API quản lý sinh viên như sau:

#%RAML 1.0
baseUri: https://localhost:8081/api
title: Student Information Management System
version: 1.0

/students:
get:
responses: 
200:
body: 
application/json:
example: [{ "id":1, "code": "001", "name": "Khanh" }, { "id":2, "code": "002", "name": "Quan" }]
/{id}:
uriParameters:
id:
description: Id of the Student
type: string
example: "1"
get:
responses: 
200:
body: 
application/json:
example: { "id":1, "code": "001", "name": "Khanh" }
delete:
responses: 
200:
body: 
application/json:
example: { "message": "Student deleted!" }

Để import tập tin RAML này vào Postman, các bạn hãy nhấn nút Import trong cửa sổ Workspace chính của Postman:

Cửa sổ chọn tập tin cần import sẽ hiển thị ra như sau:

Có nhiều định dạng file được hỗ trợ bởi Postman như OpenAPI, RAML, GraphQL, cURL hay WADL như các bạn thấy. Để import, các bạn nhấp vào nút Upload Files. Lưu ý là nếu API specs của các bạn được định nghĩa trong nhiều tập tin khác nhau thì hãy chọn tab Folder trong cửa sổ trên thay vì tab File nhé.

Sau khi chọn tập tin student.raml chứa nội dung API specs mà mình định nghĩa ở trên, các bạn sẽ thấy kết quả như sau:

Nhấn Import các bạn nhé!

Nhấn Close.

Kết quả:

Các bạn có thể click các request để xem detail cho từng request, giống như thông tin chúng ta đã định nghĩa trong tập tin RAML.

Cho mỗi request, baseUrl sẽ được Postman cấu hình sử dụng sử dụng biến với giá trị ban đầu được chúng ta định nghĩa trong tập tin RAML như sau:

Tuỳ theo nhu cầu thì các bạn có thể thay đổi biến này trong phần Environment của Postman các bạn nhé!

Bài viết gốc được đăng tải tại huongdanjava.com

Có thể bạn quan tâm:

Xem thêm công việc CNTT hấp dẫn trên TopDev