Cách Sử Dụng Apidog Trong VS Code

Tóm tắt

Tiện ích mở rộng Apidog dành cho VS Code cho phép bạn gửi yêu cầu API, quản lý bộ sưu tập, chạy kiểm thử và cộng tác với nhóm – tất cả trong trình chỉnh sửa VS Code. Thiết lập cực kỳ nhanh: chỉ cần cài đặt tiện ích mở rộng, đăng nhập tài khoản Apidog miễn phí, và không gian làm việc sẽ hiển thị ngay trên thanh bên của VS Code.

Dùng thử Apidog ngay hôm nay

💡 Apidog là nền tảng phát triển API tất cả trong một, miễn phí. Tiện ích mở rộng VS Code kết nối trực tiếp không gian làm việc Apidog với trình chỉnh sửa, giúp bạn kiểm thử API, viết tài liệu, cộng tác mà không phải chuyển đổi cửa sổ. Đăng ký miễn phí, không cần thẻ tín dụng.

Giới thiệu

Apidog xuất phát là một ứng dụng desktop để thiết kế, kiểm thử và tài liệu hóa API. Đội ngũ phát triển đã phát hành tiện ích mở rộng VS Code, kết nối trực tiếp không gian làm việc vào trình soạn thảo của bạn. Tất cả bộ sưu tập, môi trường, test case đều được đồng bộ hóa trên VS Code, desktop app và web.

Bài hướng dẫn này sẽ đi qua toàn bộ quy trình từ cài đặt, đăng nhập, gửi yêu cầu, chạy kiểm thử, cho đến chia sẻ không gian làm việc với nhóm.

Bước 1: Cài đặt tiện ích mở rộng Apidog cho VS Code

Mở VS Code, nhấn vào biểu tượng Extensions (hoặc dùng phím tắt Ctrl+Shift+X / Cmd+Shift+X).
Tìm kiếm "Apidog" trong Marketplace.
Chọn tiện ích mở rộng của Apidog Inc. (logo nền tối, chữ API cách điệu).
Nhấn Install để cài đặt.
Sau khi cài đặt, nhấn vào biểu tượng Apidog trên thanh hoạt động (Activity Bar) bên trái để mở bảng điều khiển Apidog.

Bước 2: Đăng nhập vào tài khoản Apidog

Trong bảng điều khiển Apidog, nhấn nút “Đăng nhập”.
Trình duyệt sẽ mở trang xác thực Apidog.
- Nếu có tài khoản, nhập email & mật khẩu.
- Nếu chưa có, nhấn “Đăng ký” để tạo tài khoản miễn phí (chỉ cần email, không cần thẻ tín dụng).
Sau khi xác thực, trở lại VS Code.
Không gian làm việc Apidog sẽ tự động tải trong thanh bên.

Giao diện sau khi đăng nhập:

Tên workspace ở trên cùng, dưới là cây các bộ sưu tập (collections) dạng thư mục.
Mỗi collection có thể mở rộng để xem các request.
Môi trường (Environments) có thể chọn từ dropdown trên bảng điều khiển.

Bước 3: Điều hướng bộ sưu tập

Thanh bên Apidog phản ánh chính xác cấu trúc bộ sưu tập từ không gian làm việc.
Nhấn vào mũi tên cạnh tên bộ sưu tập để mở rộng các thư mục, request.
Mỗi request hiển thị theo dòng với badge màu thể hiện HTTP method (GET, POST, PUT, DELETE).
Nhấn vào request để mở trong tab chỉnh sửa.

Tìm kiếm nhanh:

Dùng ô tìm kiếm phía trên để lọc theo tên request, URL, hoặc method.

Chuyển workspace:

Nếu có nhiều workspace, chọn nhanh trong menu trên cùng của bảng điều khiển.

Bước 4: Gửi yêu cầu API

Mở một request từ thanh bên để chỉnh sửa.
Giao diện gồm:
- Thanh trên cùng: chọn method, nhập URL, nhấn Send.
- Các tab bên dưới: Params, Headers, Body, Auth, Pre-request Scripts, Tests, Settings.
Để gửi request:
- Kiểm tra method và URL.
- Thêm headers nếu cần.
- Với request có body (POST, PUT): chuyển sang tab Body, chọn loại nội dung (JSON, form-data...).
- Nhấn Send.
Phản hồi sẽ xuất hiện ở nửa dưới, gồm status code, thời gian phản hồi, kích thước, nội dung, headers, cookie, kết quả kiểm thử.

Sử dụng môi trường:

Chọn environment ở dropdown trên cùng. Các biến như {{base_url}}, {{token}} sẽ được tự động thay thế theo môi trường.

Bước 5: Chỉnh sửa & tạo mới request

Chỉnh sửa:

Sửa trực tiếp trên giao diện, tự động đồng bộ với workspace Apidog.

Tạo request mới:

Nhấp chuột phải vào collection/thư mục trên thanh bên.
Chọn “Yêu cầu mới” (New Request).
Một tab request trống sẽ mở ra – thiết lập method, URL, headers, body.
Nhấn Ctrl+S / Cmd+S để lưu.
Request mới sẽ xuất hiện ngay trong thanh bên, đồng bộ tức thì trên desktop app, web, VS Code của đồng đội.

Quản lý:

Nhấp chuột phải vào request/thư mục để đổi tên, di chuyển, nhân bản, xoá.
Kéo-thả để sắp xếp lại các mục trong thanh bên.

Bước 6: Chạy kiểm thử API

Apidog hỗ trợ viết kiểm thử (assertion) bằng JavaScript trong tab Tests của request:

pm.test("Status is 200", function () {
  pm.response.to.have.status(200);
});

pm.test("Response contains user id", function () {
  const json = pm.response.json();
  pm.expect(json.id).to.be.a('number');
});

Sau khi gửi request, tab Tests sẽ hiển thị các assertion pass/fail kèm số lượng và thông báo lỗi.

Chạy cả bộ sưu tập:

Nhấp chuột phải vào collection/thư mục, chọn “Chạy bộ sưu tập” (Run Collection).
Tại runner panel, cấu hình số lần lặp, delay, môi trường.
Nhấn Run để chạy tất cả request trong collection, xem kết quả pass/fail cho từng assertion.

Bước 7: Kết hợp VS Code extension & desktop app

Extension VS Code và desktop app chia sẻ workspace theo thời gian thực, không có bản “chính/phụ”.
Một số quy trình điển hình:
- Thiết kế trên desktop, kiểm thử trên VS Code: Định nghĩa API, viết tài liệu, mock server trên desktop; chạy request, viết test ngay trong VS Code.
- Đánh giá nhóm: Backend update endpoint trên desktop, frontend mở VS Code thấy ngay thay đổi – không cần import/export file.
- Viết test trong ngữ cảnh: Đang code trong VS Code, mở extension Apidog, test endpoint, kiểm tra response mà không rời VS Code.
Một số thao tác (schema, mock server, xuất bản docs, quản lý nhiều environment) nên thực hiện trên desktop app để dễ thao tác hơn.

Bước 8: Chia sẻ với nhóm

Thêm thành viên vào workspace Apidog từ web/app desktop (trong phần cài đặt workspace, mời qua email).
Khi thành viên nhận lời mời và cài extension VS Code, họ sẽ thấy ngay các collection.
Thay đổi được đồng bộ hóa tự động, không cần Git, không import/export file, không merge conflict.
Gói miễn phí hỗ trợ tối đa 3 người dùng cho một workspace.

Câu hỏi thường gặp (FAQ)

Tiện ích mở rộng Apidog cho VS Code có cần desktop app không?

Không. Extension là ứng dụng khách độc lập cho workspace Apidog. Không cần cài desktop app.

Sử dụng extension khi offline thế nào?

Bạn có thể xem/chỉnh sửa collection đã cache khi offline. Gửi request hoặc đồng bộ hóa cần internet. Hỗ trợ offline hoàn toàn tùy thuộc vào dữ liệu đã cache.

Nhập collection Thunder Client hoặc Postman ra sao?

Vào mục Import trên desktop app hoặc web Apidog, chọn định dạng (Thunder Client JSON, Postman v2.1, OpenAPI...). Sau khi import sẽ thấy collection trong workspace, truy cập ngay từ extension VS Code.

Extension VS Code có phải để tạo project mới không?

Không. Extension kết nối tới workspace đã có. Tạo workspace trên desktop app hoặc web, extension chỉ là client để truy cập các workspace đó trong VS Code.

Nhiều người cùng mở/chỉnh sửa một collection được không?

Được. Không có khóa chỉnh sửa. Nếu hai người cùng sửa một request, lần lưu cuối sẽ ghi đè. Để kiểm soát chỉnh sửa, dùng tính năng cộng tác của desktop app.

Extension có hỗ trợ autocomplete biến môi trường không?

Có. Khi nhập {{ trong trường URL hoặc params, extension sẽ gợi ý biến môi trường có sẵn, giúp tránh sai tên biến.

Tiện ích mở rộng Apidog cho VS Code là công cụ tối ưu cho phát triển API ngay trong VS Code. Thiết lập nhanh, truy cập bộ sưu tập, môi trường và workspace nhóm mà không phải chuyển đổi cửa sổ, tăng tốc đáng kể quy trình làm việc của bạn.