API Testing với Postman (Phần 18) – validate json schema

 

Chắc cũng chưa có nhiều bạn biết về Json Schema và chưa biết cách test cái đó, nên mình viết bài này để các bạn biết thêm 1 cách test.

I. Json Schema là gì? Dùng làm gì?

1.ĐỊNH NGHĨA

• Schema nghĩa tiếng anh là khung, giống như outline hoặc model.

JSON Schema is a vocabulary that allows you to annotate and validate JSON documents.

HTTPS://JSON-SCHEMA.ORG/

• Từ bản Mô tả data format của json –> chúng ta áp dụng kiểm tra cấu trúc dữ liệu json khi làm API test. Nói đơn giản, chúng ta chỉ kiểm tra cái khung của response thôi, chứ không kiểm tra data của response.

2. VẬY KHI NÀO THÌ DÙNG CÁI NÀY?

• Khi mình muốn verify nhanh, không muốn mất quá nhiều thời gian vào việc viết test check từng data trong response.
• Khi mình không biết phải test data trong response như thế nào? Ví dụ: có 1 API trả về 1 list các quyển sách, bạn không biết được số lượng chính xác là bao nhiêu quyển và có những quyển sách nào, chỉ biết cấu trúc response –> chỉ verify được cấu trúc của response. (Ok, đây là ví dụ, xin đừng bắt bẻ.)

II. Cách thực hiện

1. RESPONSE LÀ OBJECT

Test sẽ là:

1

const schema = {

2

  "type": "object",

3

  "properties": {

4

    "id": {"type": "number"},

5

    "firstName": {"type": "string"},

6

    "lastName": {"type": "string"},

7

    "email": {"type": "string"},

8

    "programme": {"type": "string"},

9

    "courses": {"type": "array"}

10

  },

11

// Field nào là bắt buộc thì liệt kê ở phần require

12

  "require": ["id", "courses"]

13

};

14

​

15

pm.test("Validate schema", () => {

16

    pm.response.to.have.jsonSchema(schema);

17

});

URL cho bạn muốn thử: https://run.mocky.io/v3/a7b67072-41b3-4a4b-89b8-a540bc17b08b

Type dữ liệu là những loại sau đây:

• string
• number
• boolean
• null
• object
• array

Run trên postman:

2. KHI CÓ NESTED OBJECT

Test sẽ là:

1

const schema = {

2

    "type": "object",

3

    "properties": {

4

        "code": { "type": "string" },

5

        "error": {

6

            "type": "object",

7

            "properties": {

8

                "message": { type: "string" }

9

            },

10

            "required": ["message"]

11

        }

12

    },

13

    "required": ["code", "error"]

14

};

15

​

16

pm.test("Validate schema", () => {

17

    pm.response.to.have.jsonSchema(schema);

18

});

3. KH VALUE CÓ THỂ LÀ NHIỀU DATA TYPE

Ví dụ: message có thể là string, null hoặc object.

1

"message": { type: ["string", null, "object"] }

URL cho bạn muốn thử: https://run.mocky.io/v3/79fd4165-de48-41d9-bfab-822ce724a5e0

III. Tổng kết

Thực ra thì schema còn khá nhiều thứ phức tạp và loằng ngoằng, thiết nghĩ mình cũng không cần thiết đến mức đó, dừng lại ở mức cơ bản, kiểm tra type và required fields chắc cũng đủ rồi. Nếu bạn thấy hứng thú, muốn tìm hiểu thêm thì vào đây.