Mục tiêu

Prompt này được thiết kế để yêu cầu AI xây dựng tài liệu API REST rõ ràng, có cấu trúc, dễ dùng cho đội backend, frontend và QA. Kết quả đầu ra tập trung vào tính nhất quán, đầy đủ thông tin kỹ thuật và khả năng áp dụng ngay vào dự án.

Khi nào nên dùng

• Khi cần viết tài liệu cho API mới trước khi bàn giao cho frontend hoặc đối tác tích hợp.
• Khi muốn chuẩn hóa cách mô tả endpoint, tham số, response và lỗi.
• Khi cần chuyển ghi chú kỹ thuật rời rạc thành tài liệu dễ đọc và có thể duy trì lâu dài.
• Khi muốn AI hỗ trợ tạo tài liệu theo phong cách ngắn gọn, rõ ràng, không lan man.

Hướng dẫn tùy biến

1. Thay phần mô tả dự án bằng ngữ cảnh thực tế của hệ thống bạn đang làm.
2. Bổ sung danh sách endpoint, auth scheme, model dữ liệu hoặc quy ước HTTP status nếu đã có sẵn.
3. Chọn mức độ chi tiết phù hợp: nội bộ, bàn giao cho client, hay tài liệu public.
4. Nếu cần, yêu cầu AI xuất theo chuẩn Markdown, HTML, hoặc khung tài liệu giống OpenAPI mô tả.

Lưu ý

• Nên yêu cầu AI làm rõ giả định nếu thiếu dữ liệu đầu vào.
• Không nên để AI tự bịa endpoint hoặc field quan trọng nếu bạn đã có spec thật.
• Ưu tiên mô tả ngắn gọn nhưng đầy đủ: mục đích, cách gọi, request, response, lỗi, ví dụ.
• Kiểm tra lại tính nhất quán giữa tên field, kiểu dữ liệu và mã trạng thái HTTP trước khi dùng.

Gợi ý đầu ra mong muốn

Tài liệu nên có tiêu đề rõ ràng, mô tả chức năng, bảng hoặc danh sách endpoint, phần xác thực, ví dụ request/response, danh sách lỗi phổ biến và ghi chú quan trọng cho người tích hợp.