Mục tiêu

Prompt này giúp bạn chuyển mô tả kỹ thuật hoặc mã nguồn backend thành tài liệu API REST rõ ràng, dễ đọc và dễ dùng cho đội frontend. Kết quả hướng đến tính thực dụng: frontend có thể dựa vào tài liệu để tích hợp nhanh, hiểu đúng luồng dữ liệu và hạn chế phải hỏi lại nhiều lần.

Những gì prompt hỗ trợ tạo ra

• Mô tả endpoint theo cấu trúc nhất quán.
• Giải thích method, URL, header, query, path param, request body.
• Ví dụ request và response thành công/thất bại.
• Danh sách mã lỗi và ý nghĩa xử lý phía frontend.
• Ghi chú về xác thực, phân trang, lọc, sắp xếp và ràng buộc dữ liệu.
• Phần lưu ý tích hợp để frontend triển khai nhanh hơn.

Khi nào nên dùng

• Khi backend đã có API nhưng tài liệu còn rời rạc hoặc khó hiểu.
• Khi cần bàn giao nhanh cho đội frontend hoặc đối tác tích hợp.
• Khi muốn chuẩn hóa cách viết tài liệu giữa nhiều service.
• Khi cần AI viết lại tài liệu kỹ thuật thành ngôn ngữ rõ ràng, ít mơ hồ.
• Khi muốn bổ sung ví dụ request/response và tình huống lỗi phổ biến.

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

Dữ liệu đầu vào nên cung cấp

• Tên API hoặc module nghiệp vụ.
• Danh sách endpoint, method và URL.
• Thông tin xác thực như Bearer token, API key hoặc cookie session.
• Schema request/response hoặc ví dụ JSON thực tế.
• Danh sách mã lỗi, validation rule và quy tắc phân trang nếu có.
• Ngữ cảnh người dùng của tài liệu: frontend web, mobile, đối tác bên ngoài.

Cách tăng chất lượng đầu ra

1. Yêu cầu AI giữ cấu trúc cố định cho mọi endpoint để tài liệu đồng nhất.
2. Đưa ví dụ dữ liệu thật hoặc gần thật thay vì mô tả chung chung.
3. Nêu rõ framework hoặc style mong muốn nếu cần xuất theo chuẩn nội bộ.
4. Yêu cầu AI chỉ ra điểm mơ hồ, thiếu thông tin và đặt câu hỏi bù còn thiếu.
5. Đề nghị bổ sung mục “Lưu ý cho frontend” để giảm lỗi tích hợp.

Lưu ý

• Luôn rà soát lại tên trường, kiểu dữ liệu và mã lỗi trước khi phát hành.
• Nếu API còn thay đổi thường xuyên, nên yêu cầu AI thêm thông tin version hoặc changelog ngắn.
• Không phụ thuộc hoàn toàn vào AI khi tài liệu liên quan bảo mật, phân quyền hoặc logic nghiệp vụ quan trọng.
• Nếu đầu vào là mã nguồn, hãy loại bỏ thông tin nhạy cảm trước khi gửi cho công cụ AI.