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ý các bộ sưu tập, chạy thử nghiệm và chia sẻ không gian làm việc với nhóm của bạn – tất cả mà không cần rời khỏi trình chỉnh sửa. Thiết lập chỉ mất chưa đầy năm phút: cài đặt tiện ích mở rộng, đăng nhập vào tài khoản Apidog miễn phí của bạn, và không gian làm việc của bạn sẽ tải trực tiếp trong thanh bên của VS Code.
Giới thiệu
Apidog ban đầu là một ứng dụng máy tính để bàn (desktop app) để thiết kế API, kiểm thử và tạo tài liệu. Theo thời gian, đội ngũ phát triển đã phát hành tiện ích mở rộng VS Code giúp đưa cùng một không gian làm việc trực tiếp vào trình chỉnh sửa của bạn. Tiện ích mở rộng này không nhân đôi Apidog – nó kết nối với không gian làm việc hiện có của bạn, do đó các bộ sưu tập, môi trường và trường hợp kiểm thử luôn được đồng bộ hóa dù bạn đang sử dụng VS Code, ứng dụng máy tính để bàn hay giao diện web.
Hướng dẫn này sẽ trình bày toàn bộ quy trình làm việc: cài đặt tiện ích mở rộng, kết nối với không gian làm việc của bạn, gửi yêu cầu, chạy thử nghiệm và sử dụng tiện ích mở rộng VS Code cùng với ứng dụng máy tính để bàn.
Bước 1: Cài đặt tiện ích mở rộng Apidog cho VS Code
Mở VS Code và nhấp vào biểu tượng Extensions (Tiện ích mở rộng) trong thanh bên trái (hoặc nhấn Ctrl+Shift+X / Cmd+Shift+X).
Tìm kiếm “Apidog” trong thanh tìm kiếm của Extensions Marketplace. Tìm tiện ích mở rộng được phát hành bởi Apidog Inc. – nó hiển thị logo Apidog (một biểu tượng màu tối với các chữ cái API cách điệu).
Nhấp Cài đặt (Install). VS Code sẽ cài đặt tiện ích mở rộng và thêm biểu tượng Apidog vào Thanh hoạt động (Activity Bar) ở phía bên trái của bạn.
Sau khi cài đặt, nhấp vào biểu tượng Apidog trong Thanh hoạt động. VS Code sẽ mở bảng điều khiển Apidog trong thanh bên.
Bước 2: Đăng nhập vào tài khoản Apidog của bạn
Bảng điều khiển Apidog hiển thị nút “Đăng nhập” (Sign In). Nhấp vào đó.
Một tab trình duyệt sẽ mở ra trang xác thực của Apidog. Nếu bạn đã có tài khoản Apidog, hãy nhập email và mật khẩu của bạn. Nếu bạn chưa có tài khoản, hãy nhấp “Đăng ký” (Sign Up) – gói miễn phí chỉ yêu cầu địa chỉ email. Không cần thẻ tín dụng.
Sau khi đăng nhập, trình duyệt sẽ hiển thị thông báo xác nhận và yêu cầu bạn quay lại VS Code. Nhấp vào “Mở VS Code” (Open VS Code) hoặc chuyển về VS Code theo cách thủ công.
VS Code hoàn tất quá trình xác thực và tải không gian làm việc Apidog của bạn vào thanh bên.
Giao diện thanh bên sau khi đăng nhập: Bảng điều khiển bên trái hiển thị dạng cây của không gian làm việc của bạn. Ở trên cùng, bạn sẽ thấy tên không gian làm việc của mình. Bên dưới, các bộ sưu tập của bạn xuất hiện dưới dạng thư mục. Mỗi bộ sưu tập có thể mở rộng để hiển thị các yêu cầu bên trong, được sắp xếp theo cấu trúc thư mục. Các môi trường (Environments) xuất hiện trong một menu thả xuống ở trên cùng của bảng điều khiển.
Bước 3: Điều hướng các bộ sưu tập của bạn
Thanh bên Apidog trong VS Code phản ánh chính xác cấu trúc bộ sưu tập từ không gian làm việc Apidog của bạn.
Để duyệt một bộ sưu tập, nhấp vào mũi tên bên cạnh tên bộ sưu tập. Nó sẽ mở rộng để hiển thị các thư mục và yêu cầu. Các thư mục có thể mở rộng thêm để hiển thị từng yêu cầu.
Mỗi yêu cầu xuất hiện dưới dạng một mục dòng với một huy hiệu màu hiển thị phương thức HTTP (GET màu xanh lá cây, POST màu xanh dương, PUT màu cam, DELETE màu đỏ). Nhấp vào một yêu cầu sẽ mở nó trong khu vực trình chỉnh sửa VS Code dưới dạng một tab.
Sử dụng thanh tìm kiếm: Ở trên cùng của bảng điều khiển Apidog, có một ô tìm kiếm. Nhập bất kỳ từ khóa nào để lọc các bộ sưu tập của bạn theo tên yêu cầu, URL hoặc phương thức. Điều này hữu ích khi không gian làm việc của bạn có hàng chục bộ sưu tập.
Chuyển đổi không gian làm việc: Nếu tài khoản Apidog của bạn thuộc nhiều không gian làm việc (cá nhân, nhóm hoặc theo dự án), một bộ chọn không gian làm việc ở trên cùng của bảng điều khiển cho phép bạn chuyển đổi giữa chúng.
Bước 4: Gửi yêu cầu
Khi bạn mở một yêu cầu từ thanh bên, nó sẽ tải trong khu vực trình chỉnh sửa chính dưới dạng một tab. Giao diện yêu cầu có bố cục quen thuộc:
Thanh trên cùng: Bộ chọn phương thức (menu thả xuống với GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS), trường URL và nút Gửi (Send).
Các tab bên dưới URL: Params (Tham số), Headers (Tiêu đề), Body (Nội dung), Auth (Xác thực), Pre-request Scripts (Tập lệnh trước yêu cầu), Tests (Kiểm thử), Settings (Cài đặt). Mỗi tab sẽ mở phần cấu hình liên quan.
Để gửi yêu cầu:
- Xác nhận phương thức và URL trong thanh trên cùng
- Thêm bất kỳ tiêu đề bắt buộc nào trong tab Headers
- Nếu yêu cầu có nội dung (POST, PUT), nhấp vào Body và chọn loại nội dung (JSON, form data, binary, v.v.)
- Nhấp Gửi (Send)
Phản hồi sẽ xuất hiện ở nửa dưới của tab. Nó hiển thị mã trạng thái, thời gian phản hồi và kích thước phản hồi. Các tab bên dưới phần phản hồi cho phép bạn xem nội dung (với tính năng tô sáng cú pháp cho JSON và XML), tiêu đề, cookie và kết quả kiểm thử.
Sử dụng môi trường: Bộ chọn môi trường ở trên cùng của bảng điều khiển Apidog sẽ thiết lập môi trường hoạt động. Các biến như {{base_url}} hoặc {{token}} sẽ được giải quyết thành các giá trị được định nghĩa trong môi trường đó. Chuyển đổi môi trường để chạy cùng một yêu cầu đối với môi trường dev (phát triển), staging (thử nghiệm) hoặc production (sản phẩm) mà không cần chỉnh sửa URL.
Bước 5: Chỉnh sửa và tạo yêu cầu
Bạn có thể chỉnh sửa các yêu cầu hiện có trực tiếp trong VS Code. Các thay đổi sẽ tự động đồng bộ hóa với không gian làm việc Apidog của bạn.
Để tạo yêu cầu mới:
- Nhấp chuột phải vào một bộ sưu tập hoặc thư mục trong thanh bên
- Chọn “Yêu cầu mới” (New Request)
- Một tab yêu cầu trống sẽ mở ra
- Thiết lập phương thức, URL, tiêu đề và nội dung
- Nhấn
Ctrl+S/Cmd+Sđể lưu
Yêu cầu mới sẽ xuất hiện trong thanh bên và có thể truy cập ngay lập tức từ ứng dụng máy tính để bàn Apidog, giao diện web hoặc VS Code của bất kỳ đồng đội nào.
Đổi tên và sắp xếp: Nhấp chuột phải vào bất kỳ yêu cầu hoặc thư mục nào trong thanh bên để truy cập các tùy chọn đổi tên, di chuyển, nhân đôi và xóa. Tính năng kéo và thả để sắp xếp lại hoạt động trong thanh bên.
Bước 6: Chạy thử nghiệm
Apidog hỗ trợ các khẳng định kiểm thử chạy sau mỗi phản hồi. Trong tab Tests của một yêu cầu đang mở, bạn có thể viết các khẳng định dựa trên JavaScript:
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 nhấp Gửi (Send), tab Tests trong phần phản hồi sẽ hiển thị những khẳng định nào đã vượt qua và những khẳng định nào đã thất bại, kèm theo số lượng đạt/thất bại và thông báo lỗi cho các trường hợp thất bại.
Chạy một bộ sưu tập: Nhấp chuột phải vào một bộ sưu tập hoặc thư mục trong thanh bên và chọn “Chạy bộ sưu tập” (Run Collection). Một bảng điều khiển chạy (runner panel) sẽ mở ra, nơi bạn có thể thiết lập số lần lặp, độ trễ giữa các yêu cầu và môi trường. Nhấp Chạy (Run) để thực thi tất cả các yêu cầu theo trình tự. Kết quả sẽ hiển thị trạng thái đạt/thất bại cho các khẳng định của mỗi yêu cầu.
Bước 7: Sử dụng tiện ích mở rộng VS Code và ứng dụng máy tính để bàn cùng nhau
Tiện ích mở rộng VS Code và ứng dụng máy tính để bàn chia sẻ cùng một không gian làm việc theo thời gian thực. Không có phiên bản “chính” nào – chúng là hai giao diện khác nhau của cùng một dữ liệu.
Các quy trình làm việc phổ biến sử dụng cả hai:
Thiết kế trên desktop, kiểm thử trong VS Code: Sử dụng ứng dụng máy tính để bàn Apidog để định nghĩa lược đồ API của bạn, viết tài liệu và thiết lập máy chủ giả (mock servers). Sau đó chuyển sang VS Code để chạy các yêu cầu và viết các khẳng định kiểm thử mà không cần rời khỏi môi trường phát triển của bạn.
Đánh giá API nhóm: Một nhà phát triển backend cập nhật một endpoint trong ứng dụng máy tính để bàn. Một nhà phát triển frontend mở VS Code với tiện ích mở rộng Apidog và ngay lập tức thấy yêu cầu đã được cập nhật với các tham số mới. Không cần pull request, không cần nhập tệp JSON.
Viết kiểm thử trong ngữ cảnh: Bạn đang viết mã trong VS Code để sử dụng một API. Mà không cần chuyển đổi cửa sổ, bạn có thể mở bảng điều khiển Apidog, tìm endpoint liên quan, chạy nó, kiểm tra cấu trúc phản hồi và quay lại mã của bạn – luôn ở trong cùng một ứng dụng suốt thời gian đó.
Những gì ứng dụng máy tính để bàn làm tốt hơn: Thiết kế lược đồ (schema), thiết lập máy chủ giả (mock server), xuất bản tài liệu API và quản lý số lượng lớn môi trường. Đây là những tính năng ưu tiên của ứng dụng máy tính để bàn mà bạn có thể tham chiếu từ VS Code nhưng dễ cấu hình hơn trong chế độ xem toàn màn hình của desktop.
Bước 8: Chia sẻ với nhóm của bạn
Nếu bạn làm việc với một hoặc hai nhà phát triển khác, hãy thêm họ vào không gian làm việc Apidog của bạn. Từ giao diện web Apidog hoặc ứng dụng máy tính để bàn, hãy vào cài đặt không gian làm việc của bạn và mời đồng đội qua email.
Khi họ chấp nhận lời mời và cài đặt tiện ích mở rộng VS Code, thanh bên của họ sẽ hiển thị các bộ sưu tập giống như bạn thấy. Bất kỳ yêu cầu nào họ thêm hoặc sửa đổi sẽ xuất hiện ngay lập tức cho tất cả mọi người.
Gói miễn phí hỗ trợ tối đa ba người dùng. Các thay đổi được đồng bộ hóa thông qua đám mây của Apidog – không cần thao tác Git, không cần xuất tệp, không có xung đột hợp nhất.
Câu hỏi thường gặp (FAQ)
Tiện ích mở rộng Apidog cho VS Code có hoạt động mà không cần ứng dụng máy tính để bàn không?Có. Tiện ích mở rộng là một ứng dụng khách (client) hoàn chỉnh cho không gian làm việc Apidog của bạn. Bạn không cần cài đặt ứng dụng máy tính để bàn để sử dụng tiện ích mở rộng này.
Tôi có thể sử dụng tiện ích mở rộng Apidog cho VS Code khi ngoại tuyến không?Bạn có thể xem và chỉnh sửa các bộ sưu tập đã được lưu vào bộ nhớ đệm khi ngoại tuyến. Gửi yêu cầu đến các API bên ngoài yêu cầu truy cập internet (cũng như việc đồng bộ hóa các thay đổi). Hỗ trợ ngoại tuyến đầy đủ phụ thuộc vào trạng thái bộ nhớ đệm của không gian làm việc Apidog của bạn.
Làm cách nào để nhập các bộ sưu tập Thunder Client hoặc Postman hiện có?Trong ứng dụng máy tính để bàn Apidog hoặc giao diện web, hãy vào mục Nhập (Import) và chọn định dạng phù hợp (Thunder Client JSON, Postman collection v2.1, OpenAPI, v.v.). Các bộ sưu tập đã nhập sẽ xuất hiện trong không gian làm việc của bạn và có thể truy cập ngay lập tức từ tiện ích mở rộng VS Code.
Tiện ích mở rộng VS Code có giống với việc tạo một dự án mới trong Apidog không?Không. Tiện ích mở rộng kết nối với không gian làm việc Apidog hiện có của bạn. Bạn tạo và quản lý không gian làm việc từ ứng dụng máy tính để bàn hoặc giao diện web. Tiện ích mở rộng VS Code là một ứng dụng khách cho phép bạn làm việc trong các không gian làm việc đó từ VS Code.
Nhiều người có thể mở cùng một bộ sưu tập cùng lúc không?Có. Tiện ích mở rộng không khóa các bộ sưu tập để chỉnh sửa. Nếu hai người dùng chỉnh sửa cùng một yêu cầu đồng thời, lần lưu cuối cùng sẽ được ưu tiên. Để chỉnh sửa có sự phối hợp, hãy sử dụng các tính năng cộng tác của ứng dụng máy tính để bàn.
Tiện ích mở rộng có hỗ trợ tự động hoàn thành biến môi trường không?Có. Khi bạn gõ {{ vào trường URL hoặc tham số, tiện ích mở rộng sẽ gợi ý các biến có sẵn từ môi trường đang hoạt động. Điều này giúp tránh lỗi chính tả trong tên biến.
Tiện ích mở rộng Apidog cho VS Code hoạt động tốt nhất như công cụ hàng ngày của bạn khi bạn đã phát triển API bên trong VS Code. Chi phí thiết lập chỉ hai phút sẽ nhanh chóng được đền đáp khi các bộ sưu tập, môi trường và không gian làm việc nhóm của bạn đều có thể truy cập mà không cần chuyển đổi cửa sổ.