Bỏ qua điều hướng

Prompt miễn phí

Thiết kế API REST quản lý đơn hàng

Tạo đặc tả API REST nhất quán cho hệ thống đơn hàng gồm endpoint, request, response và mã lỗi.

Onter AdminCập nhật 26/09/2026 Mới · Chưa có đánh giá 0 lượt copy
CodingChatGPTClaudeCodex

Prompt dùng để làm gì?

Tạo đặc tả API REST nhất quán cho hệ thống đơn hàng gồm endpoint, request, response và mã lỗi.

Điền thông tin của bạn

Prompt

Bạn là kiến trúc sư API cho hệ thống quản lý đơn hàng. Dựa trên {{yeu_cau_nghiep_vu}}, hãy thiết kế một API REST rõ ràng, nhất quán và dễ triển khai. Nếu có {{doi_tuong_chinh}}, hãy dùng nó để xác định resource, ví dụ order, customer, item hoặc payment; nếu có {{quy_tac_nghiep_vu}}, hãy phản ánh chúng trong validation, state transition và thông báo lỗi. Trình bày đầy đủ: danh sách endpoint, method, mục đích, path parameters, query parameters, request body mẫu, response thành công, response lỗi, mã trạng thái HTTP, và quy ước đặt tên trường dữ liệu. Ưu tiên thiết kế thực dụng, tránh endpoint thừa, tránh trộn logic nghiệp vụ vào URL, và giữ cấu trúc nhất quán giữa create, update, list, detail và action đặc biệt. Nếu có phần nào cần phân quyền hoặc idempotency, hãy nêu rõ giả định và cách thể hiện trong API spec.
Xem đã lưu

Input mẫu

yeu_cau_nghiep_vu: quản lý tạo đơn, xem chi tiết đơn, cập nhật trạng thái và hủy đơn
doi_tuong_chinh: order, customer
quy_tac_nghiep_vu: không cho hủy đơn đã giao; mã đơn là duy nhất

Output mẫu

Một đặc tả gồm GET /orders, POST /orders, GET /orders/{id}, PATCH /orders/{id}/status, DELETE /orders/{id}; request body có customerId, items, shippingAddress; response nêu trạng thái đơn, tổng tiền, mã lỗi 400/404/409; quy tắc không cho hủy đơn đã giao được đưa vào phần validation.

Cách sử dụng

Điền mô tả nghiệp vụ đủ cụ thể, rồi dán prompt vào công cụ tạo tài liệu kỹ thuật hoặc chat code. Sau khi nhận đặc tả, đối chiếu lại với quy trình nghiệp vụ để chắc chắn endpoint, mã lỗi và cấu trúc dữ liệu không mâu thuẫn.

Giải thích cấu trúc

Role
Vai trò là kiến trúc sư API và biên soạn đặc tả REST.
Context
Bối cảnh là hệ thống quản lý đơn hàng cần các endpoint rõ ràng, nhất quán và dễ triển khai.
Task
Thiết kế resource, method, request/response và mã lỗi theo nghiệp vụ.
Constraints
Không tạo endpoint dư thừa; phải phản ánh quy tắc nghiệp vụ và tình huống lỗi thực tế.
Output
Bộ đặc tả API có thể dùng làm nền cho implementation hoặc review kỹ thuật.

Mẹo sử dụng

  • Tách rõ endpoint cho collection, item và action đặc biệt nếu có.
  • Dùng mã lỗi 409 cho xung đột trạng thái, 422 khi dữ liệu hợp lệ nhưng không thỏa nghiệp vụ.
  • Nêu ví dụ request/response tối thiểu để tránh hiểu sai cấu trúc.
  • Nếu có phân trang, lọc hoặc sắp xếp, hãy quy ước ngay từ đầu.

Nguồn và giấy phép

ONTER biên tập · original

Đánh giá prompt

Chọn số sao theo trải nghiệm của bạn. Bạn có thể sửa đánh giá sau một phút.

Prompt liên quan

Tài khoản Onter

Đăng nhập rồi tiếp tục việc đang làm.

Mở trang đăng nhập riêng nếu trình duyệt chưa hiển thị biểu mẫu.

Contact Me on Zalo