Mục tiêu

Bộ prompt này giúp đội backend hoặc technical writer tạo tài liệu API REST rõ ràng, đầy đủ và nhất quán để đội frontend có thể tích hợp nhanh hơn, giảm hỏi lại và hạn chế hiểu sai logic nghiệp vụ.

Khi nào nên dùng

• Khi cần bàn giao endpoint mới cho đội frontend.
• Khi muốn chuẩn hóa tài liệu API hiện có từ ghi chú rời rạc, ticket hoặc mã nguồn.
• Khi cần mô tả request, response, authentication, validation, pagination, error code và edge case.
• Khi chuẩn bị nội dung đưa vào Swagger, Postman, Notion, Confluence hoặc tài liệu nội bộ.

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

1. Thay các phần trong ngoặc vuông bằng thông tin API thực tế như tên endpoint, method, URL, header, body, response và rule nghiệp vụ.
2. Nếu chưa có đủ dữ liệu, hãy yêu cầu AI đặt câu hỏi làm rõ trước khi viết tài liệu.
3. Có thể yêu cầu định dạng đầu ra theo bảng, OpenAPI-style, Postman documentation hoặc tài liệu nội bộ tùy nhu cầu.
4. Với API phức tạp, nên cung cấp thêm flow nghiệp vụ, quyền truy cập, trạng thái dữ liệu và ví dụ lỗi phổ biến.

Lưu ý

• Không đưa secret key, token thật, thông tin người dùng thật hoặc dữ liệu nhạy cảm vào prompt.
• Nên kiểm tra lại mọi status code, schema, validation rule và ví dụ response trước khi gửi cho frontend.
• Nếu API có breaking change, hãy yêu cầu AI thêm mục thay đổi so với phiên bản trước để đội frontend dễ cập nhật.