Làm quen với giao diện Postman

Giao diện của Postman gồm nhiều điều hướng quan trọng và cần thiết. Trong đó gồm 4 phần điều hướng quan trọng sau đây:

• Menu chính
• Thanh bên điều hướng
• Vùng định nghĩa yêu cầu
• Vùng tiếp nhận phản hồi

Dưới đây là hình chụp màn hình thể hiện các vùng điều hướng trong Postman:

Vùng menu chính

Vùng menu chính gồm có các mục con như: Home, Workspaces, API Network, công cụ tìm kiếm, lời mời cộng tác, thiết lập, thông báo, hồ sơ tài khoản, gợi ý nâng cấp, New và Import.

Mục Home sẽ điều hướng bạn đến trang chủ của Postman, nơi đây bạn có thể xem danh sách các không gian làm việc mà bạn từng mở gần đây và khám phá thêm các hướng dẫn những chức năng bạn có thể làm với Postman. Ngoài ra, bạn cũng được giới thiệu khám phá những API phổ biến hiện nay.

Mục Workspace sẽ hiển thị danh sách không gian làm việc hiện có trên tài khoản Postman của bạn. Tại đây bạn có thể tìm kiếm trong danh sách hoặc tạo không gian làm việc mới bằng cách nhấn Create Workspace.

Mục API Network sẽ hiển thị danh sách các API được phân thành hai loại là API công cộng (public) và API nội bộ (internal). Mục này cũng bao gồm một số hướng dẫn hữu ích cho bạn để khám phá và tương tác với các dạng API.

Mục công cụ tìm kiếm (có biểu tượng hình kính lúp) sẽ hỗ trợ bạn tìm kiếm nhanh chóng các tài nguyên trên Postman như các không gian làm việc (workspace), các bộ sưu tập (collection), các request, các API, ...

Mục thiết lập (có biểu tượng hình răng cưa) sẽ giúp bạn tùy chỉnh Postman cho phù hợp với nhu cầu của bạn. Các thiết lập bao gồm: các thiết lập chung, tùy chỉnh giao diện, các phím tắt, dữ liệu, các tiện ích mở rộng, chứng thư bảo mật, cổng proxy, cập nhật chương trình, ...

Mục thông báo (có biểu tượng hình cái chuông) là nơi hiển thị tất cả thông báo từ hệ thống đến bạn. 

Mục lời mời cộng tác sẽ xuất hiện khi bạn đang mở một không gian làm việc nhất định. Chức năng này giúp bạn mời những người khác vào làm việc cùng với bạn trên một không gian đã chỉ định. Bạn có thể nhập tên, email hoặc tên nhóm và nhấn Send Invite để gửi lời mời.

Mục hồ sơ tài khoản sẽ hiển thị thông tin tài khoản mà bạn đang đăng nhập vào Postman. Tại đây bạn có thể xem thông tin hồ sơ, thiết lập và đăng xuất, chuyển đổi sang tài khoản khác.

Mục gợi ý nâng cấp (Upgrade) sẽ hiển thị các thống kê số lượng các tài nguyên đã sử dụng và hạn mức còn lại hiện tại. Ngoài ra, bạn có thể xem xét các chức năng như sử dụng các gói trả phí (Billing), quản lý các thay đổi (audit log), ...

Mục New dùng để tạo ra các đối tượng mới trong Postman như các request, bộ sưu tập, không gian lảm việc, luồng, GraphQL, MQTT, ...

Mục Import giúp bạn có thể nhập các tài nguyên, bộ sưu tập, các request từ nguồn khác vào trong Postman của bạn. Bạn có thể click chọn để nhập tập tin hoặc cả thư mục. Hoặc bạn có thể kéo thả tập tin, thư mục vào trong khu vực kéo thả của Postman.

Thanh bên điều hướng

Thanh bên bao gồm Bộ sưu tập (được sử dụng để sử dụng các request kiểm tra, chứa các thư mục, thư mục con, các request), Lịch sử (ghi lại tất cả các yêu cầu API được thực hiện trong quá khứ) và các API.

Vùng định nghĩa request

Vùng định nghĩa request (theo các tài liệu tiếng Anh thì gọi đây là Builder). Đây là phần quan trọng nhất của ứng dụng Postman. Tại vùng này, bạn sẽ thấy các request được thể hiện theo dạng tab, bạn có thể dễ dàng xem chi tiết một request bằng cách chọn vào tab tương ứng. Tên của yêu cầu sẽ được hiển thị trên tab, Theo mặc định, request chưa có tiêu đề sẽ được đặt là "Untitled Request".

Trong vùng làm việc cho mỗi request cụ thể, bạn có thể thay đổi loại request (GET, POST, PUT, DELETE, ...) và địa chỉ URL của API. Một request sẽ được thực thi sau mỗi lần bạn nhấn nút Send. Nếu có bất kỳ sửa đổi nào đối với request đó, bạn có thể nhấn nút Save để lưu lại thay đổi mới.

Vùng làm việc cho mỗi request cũng có các tab như Param (tham số), Xác thực và phân quyền (Authorization), Headers, Body, Script thực thi trước khi gửi request, Tests và Thiết lập. Các tham số của một request được định nghĩa trong tab Params. Các tham số này sẽ truyền qua URL của API.

Ví dụ: /api/user/get-detail?id=xxx

• /api/user/get-detail là URL của API
• id là khóa của tham số
• xxx là giá trị tham số

Tab Xác thực và phân quyền cho một API là phần để định nghĩa liên quan đến xác thực cho request khi truyền đi. Có nhiều loại xác thực hiện nay như Basic Auth chỉ gồm tên người dùng và mật khẩu. Ngoài ra còn nhiều loại khác như token, JWT token, Bearer Token, OAuth 2.0, ...

Các header của request được xác định trong các tab Headers. Các cặp giá trị này được gửi thông qua phần header của request, không nhìn thấy được trên URL.

Body của request được xác định trong tab Body tương ứng. Postman hỗ trợ bạn định nghĩa nhiều loại body khác nhau như: form-data, x-www-form-urlencoded, raw (text, JSON, JavaScript, HTML, XML), binary (dạng nhị phân như tập tin), ...

Đặc biệt nếu bạn muốn tùy biến sâu hơn như là xử lý trước khi gửi đi request, bạn có thể viết các đoạn mã này bằng ngôn ngữ JavaScript. Bạn viêt vào trong tab Pre-request Script bạn nhé.

Khác hẳn với tab Pre-request, Tab Tests chứa các đoạn mã được thực thi sau khi một request được gửi đi và nhận lại được kết quả từ máy chủ (chứa API). Điều này giúp xác nhận xem API hoạt động đúng cách và dữ liệu và mã phản hồi nhận được có đúng hay không.

Phần thiết lập cho việc gửi request và nhận response sẽ được thể hiện trong tab Setting. Mình sẽ giải thích sâu hơn về tab này ở các bài viết sau nhé.

Vùng tiếp nhận phản hồi

Phần tiếp nhận phản hồi sẽ chỉ có các giá trị sau khi request được tiếp nhận và xử lý từ máy chủ chứa API. Nó thường chứa các chi tiết của phản hồi. Tại mục này gồm có các tab như Body, Cookies, Headers, Test Results.

Với tab Body, tại đây sẽ thể hiện giá trị trả về từ máy chủ, được thể hiện dưới nhiều dạng dữ liệu như JSON, HTML, XML, Text, ... Bạn có thể định dạng lại cách trình bày bằng tùy chọn Pretty để làm cho kết quả dễ nhìn và trực quan hơn.

Tab Cookies chứa thông tin các cookie được trả về từ máy chủ. Các header từ máy chủ trả về sẽ được thể hiện thông qua tab Headers tương ứng. Tab Results sẽ thể hiện kết quả của đoạn mã mà bạn đã viết trong tab Tests khi định nghĩa request.

Ngoài ra, bạn cũng có thể xem được các thông tin khác như HTTP Code mà máy chủ trả về. Trong hình minh họa là 200 - OK. Thời gian mà máy chủ xử lý và trả về (đơn vị mili giây), kích thước của kết quả trả về (đơn vị KB).