Tạo một Endpoint
Endpoint là gì?
| Thành phần | Mô tả | Ví dụ |
|---|---|---|
| Phương thức HTTP | Hành động cần thực hiện | GET, POST, PUT, DELETE |
| Đường dẫn | Đường dẫn URL tương đối so với base URL | /users/{id} |
| Tham số | Tham số path, query, header hoặc body | id (tham số path) |
| Body yêu cầu | Dữ liệu được gửi cùng với yêu cầu (đối với POST/PUT) | JSON schema |
| Phản hồi | Định dạng phản hồi và mã trạng thái dự kiến | 200 OK, 404 Not Found |
Khái niệm chính
Tạo Endpoint
Điều kiện tiên quyết
Bắt đầu nhanh: Tạo endpoint cơ bản
1.
2.
Các phương thức tạo endpoint
| Phương thức | Khi nào sử dụng | Các bước |
|---|---|---|
| Tạo thủ công | Bắt đầu từ đầu | 1. Nhấp chuột phải vào thư mục → "New Endpoint" 2. Điền phương thức và đường dẫn 3. Định nghĩa tham số và phản hồi |
| Nhập từ mã | Mã API hiện có | 1. Sử dụng tính năng "Import" 2. Tải lên tệp OpenAPI/Swagger 3. Ánh xạ vào các mô-đun |
| Từ yêu cầu | Kiểm thử các API hiện có | 1. Trước tiên gửi một yêu cầu 2. Nhấp vào "Save" 3. Tinh chỉnh đặc tả |
| Sao chép endpoint hiện có | Các endpoint tương tự | 1. Nhấp chuột phải vào endpoint → "Duplicate" 2. Sửa đổi đường dẫn và tham số |
Chỉ định chi tiết endpoint
Thông tin cơ bản
Tham số
Tham số Path
GET /users/{userId}/posts/{postId}| Tham số | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
userId | integer | Có | Mã định danh người dùng duy nhất |
postId | integer | Có | Mã định danh bài đăng |
Tham số Query
| Tham số | Kiểu | Bắt buộc | Mặc định | Mô tả |
|---|---|---|---|---|
limit | integer | Không | 10 | Số lượng kết quả cần trả về |
offset | integer | Không | 0 | Số lượng kết quả cần bỏ qua |
status | string | Không | active | Lọc theo trạng thái |
Body yêu cầu (đối với POST/PUT)
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "User's full name"
},
"email": {
"type": "string",
"format": "email",
"description": "User's email address"
}
},
"required": ["name", "email"]
}Phản hồi
Phản hồi thành công (200 OK)
{
"id": 123,
"name": "John Doe",
"email": "john@example.com",
"createdAt": "2023-01-15T10:30:00Z"
}Phản hồi lỗi
| Mã trạng thái | Mô tả | Schema |
|---|---|---|
400 | Bad Request | Chi tiết lỗi |
401 | Unauthorized | Lỗi xác thực |
404 | Not Found | Không tìm thấy tài nguyên |
500 | Internal Server Error | Chi tiết lỗi máy chủ |
Modified at 2026-06-11 10:23:06