Apidog client hỗ trợ gửi yêu cầu API bằng HTTP, GraphQL, SOAP, gRPC và các giao thức phổ biến khác. Bạn có thể tạo yêu cầu trong Apidog, gửi chúng để quan sát phản hồi và lưu chúng để cộng tác nhóm.Tạo một yêu cầu mới#
Để tạo một yêu cầu trong Apidog, bạn chỉ cần nhấp vào "+" → "Yêu cầu mới".Bạn có thể điền các phần cần thiết của yêu cầu theo đặc tả API vào giao diện Apidog, chẳng hạn như phương thức yêu cầu, URL, tham số yêu cầu, ủy quyền, v.v.Bằng phương pháp này, bạn có thể tạo các yêu cầu HTTP, GraphQL và SOAP. Tìm hiểu thêm về cách tạo yêu cầu WebSocket và gRPC trong tài liệu giao thức tương ứng.URL yêu cầu#
Để thực hiện một yêu cầu trong Apidog, bạn cần chỉ định URL đại diện cho endpoint API mà bạn đang kết nối tới. Mỗi thao tác bạn có th ể thực hiện bằng API thường được liên kết với một endpoint, có một URL cụ thể.Nếu bạn đang xây dựng một API: URL thường sẽ bao gồm vị trí cơ sở cộng với một đường dẫn. Ví dụ, trong URL yêu cầu https://api.example.com/user/12, https://api.example.com là URL cơ sở và /user/12 là đường dẫn endpoint.
Nếu bạn đang sử dụng một API công khai: Nhà cung cấp API của bạn sẽ cung cấp các URL bạn cần trong tài liệu dành cho nhà phát triển của họ.
Apidog sẽ tự động thêm http:// vào đầu URL của bạn nếu bạn không chỉ định giao thức.
Phương thức yêu cầu#
Trong Apidog, bạn có thể chọn phương thức yêu cầu cần sử dụng ở phía bên trái của URL yêu cầu. Phương thức mặc định là GET.Các phương thức HTTP phổ biến#
| Phương thức | Mục đích | Tác động đến dữ liệu |
|---|
| GET | Truy xuất dữ liệu từ một tài nguyên được chỉ định | Chỉ đọc, không có tác dụng phụ |
| POST | Gửi dữ liệu để được xử lý tới một tài nguyên được chỉ định | Tạo tài nguyên mới |
| PUT | Cập nhật tài nguyên hiện có | Thay thế toàn bộ tài nguyên |
| PATCH | Áp dụng các sửa đổi một phần cho một tài nguyên | Cập nhật các trường cụ thể |
| DELETE | Yêu cầu xóa một tài nguyên | Xóa tài nguyên |
Trong thiết kế API, cùng một URL có thể được yêu cầu bằng các phương thức khác nhau, đại diện cho các thao tác khác nhau trên cùng một tài nguyên. Ví dụ, GET /user/{id} thường truy xuất thông tin người dùng cho id này, trong khi PUT /user/{id} cập nhật thông tin người dùng cho id này.Gửi yêu cầu#
Sau khi bạn chỉ định giao thức, phương thức và URL của yêu cầu, hãy thêm mọi chi tiết khác mà API bạn đang gửi yêu cầu tới yêu cầu:Tham số và Body: Cung cấp mọi tham số, dữ liệu body hoặc header yêu cầu cần được gửi cùng với yêu cầu.
Xác thực: Thiết lập mọi xác thực và ủy quyền bắt buộc.
Cookie: Bạn cũng có tùy chọn sử dụng cookie với các yêu cầu của mình bằng cách chọn tab Cookies.
Bạn có thể xem các yêu cầu mình đã gửi trong History ở thanh bên và gửi lại chúng. Điều này hữu ích cho việc gỡ lỗi và so sánh các phản hồi theo thời gian.
