postman

Nghịch ngợm RestAPI với Postman – Gọi API đâu có gì khó?

Series Nhận Diện Idol vẫn đang tiếp tục được viết. Tuy nhiên, trong quá trình code sẽ phải sử dụng khá nhiều RestAPI (Của Microsoft, Imgur,…). Để đủ kiến thức theo đuổi series, bạn cần hiểu rõ bản chất RestAPI và cách sử dụng chúng.

Nếu các bạn chưa hiểu rõ về RestAPI có thể xem lại ở đây.  Ta thường dùng code để gọi các API này, tuy nhiên việc viết code và chạy code khá lắt nhắt và tốn công. Do vậy, hôm nay mình giới thiệu thêm tool mình hay dùng khi làm việc với RestAPI mang tên Postman.

(Tool này sẽ được sử dụng khá nhiều trong series Nhận diện Idol, các bạn nhớ đọc để biết cách sử dụng nhé)

Giới thiệu và cài đặt

Postman là một tool rất thuận tiện cho việc gọi và test RestAPI, được 1.5 triệu developer trên toàn thế giới tin dùng. Với Postman, ta có thể gọi RestAPI mà không cần viết dòng code nào. Làm chủ Postman, các bạn sẽ biết thấy việc gọi các RestAPI (như Facebook, Google, Youtube) chả có gì phức tạp cả.

Các bạn có thể tải về bản full ở đây: https://www.getpostman.com/. Cá nhân mình thì dùng bản add-on của Chrome cho nhẹ máy: https://chrome.google.com/webstore/detail/postman/fhbjgbiflinjbdggehcddcbncdddomop?hl=en

screen-shot-2017-01-01-at-8-36-45-pm

Sau khi cài đặt, các bạn bấm vào app, chọn Postman, giao diện đăng nhập sẽ hiện ra. Bạn có thể bấm “Skip This” để bỏ qua phần đăng nhập, tuy nhiên mình khuyến khích nên tạo account và đăng nhập vì Postman có thể đồng bộ dữ liệu của bạn trên nhiều máy, khá tiện lợi.

screen-shot-2017-01-01-at-8-38-49-pm
Giao diện chính của chương trình. Bên trái là danh sách các request bạn đã gọi. Bên phải là thông tin của 1 request.

Một số khái niệm

Post khá dễ sử dụng, bạn chỉ cần nắm một số khái niệm sau:

Request: Để sử dụng RestAPI, ta sẽ gửi một HTTP Request tới endpoint của API đó. Ví dụ như để lấy thông tin người dùng github có username là conanak99, ta sẽ gửi HTTP GET Request tới endpoint: https://api.github.com/users/conanak99.

Mỗi request này chứa những thông tin như URL, method (POST, GET), body (trường hợp dùng POST hay PUT), HTTP header.

screen-shot-2017-01-01-at-10-07-20-pm

screen-shot-2017-01-01-at-10-07-27-pm
Thông tin về 1 request: URL, Headers, Body

Collection: Collection là một tập hợp của nhiều request. Những request liên quan tới nhau thì ta gom lại vào chung 1 collection để dễ quản lý hơn.

screen-shot-2017-01-01-at-10-02-02-pm
Request của mình được gom nhóm lại thành nhiều collection

Enviroment và variable: Trong dự án thực tế, người ta thường dùng deploy RestAPI trên nhiều môi trường (local, test, production). Postman hỗ trợ cài đặt các biến môi trường (url gốc, API key, …), thuật tiện hơn khi cần test trên nhiều môi trường

Các chức năng cơ bản

Các chức năng hay được sử dụng của Postman bao gồm:

  • Cho phép gửi HTTP Request với các method GET, POST, PUT, DELETE.
  • Cho phép thay đổi header header của các request
  • Cho phép post dữ liệu dưới dạng form (key-value), text, json
  • Hiện kết quả trả về dạng text, hình ảnh, XML, JSON
  • Hỗ trợ authorization (Oauth1, 2)

Để gửi 1 request, ta chỉ cần dán URL vào khung text, chọn method, điền header, body, sau đó bấm Send là xong. Các bạn có thể thử dán link này vào và bấm send để xem kết quả trả về dưới dạng JSON: http://jav.toidicodedao.com/api/actress

Một số ví dụ minh họa

Gọi API của Github (Method GET)

screen-shot-2017-01-01-at-10-22-56-pm

Gọi API của Youtube tìm “Đậu Phộng Trôi” của Sơn Tùng (Method GET với key params)

screen-shot-2017-01-01-at-10-36-25-pm

Gọi API nhận diện Idol (Post JSON, key nằm trong header)

screen-shot-2017-01-01-at-10-21-25-pm

Lưu và gom nhóm request (Bấm Save hoặc Ctrl+S để lưu Request)

screen-shot-2017-01-01-at-10-24-25-pm

Kết

Qua bài hướng dẫn này, bạn đã có cái nhìn tổng quát về của Postman, đồng thời biết cách sử dụng những chức năng chính của nó. Postman rất hữu dụng với các Web Developer khi bạn cần test cách truyền params hoặc xem kết quả trả về từ một RestAPI nào đó.

Ngoài ra, Postman còn có các chức năng khá hay như: Viết và chạy test case cho API, export collection để chía sẻ với người khác, các bạn có thể tự mày mò tìm hiểu thêm. Nếu bạn có câu hỏi hay thắc mắc gì thì cứ comment trong bài nhé.

Advertisements

7 thoughts on “Nghịch ngợm RestAPI với Postman – Gọi API đâu có gì khó?”

      1. Hiện tại bên e có dùng RSA key nên mỗi lần add key chỉ dùng được khoản 3 phút thôi

        Like

  1. Thank bạn Hoàng nhiều hen, vẫn luôn theo dõi Blog của bạn hằng ngày. Sau này mình lỡ lên lead còn bạn vẫn code dạo thì alo mình hen, mình sẽ tuyển ko cần interview. A hihihi

    Liked by 1 person

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s