Viết tài liệu cho một API endpoint

Giúp người dùng API biết gửi gì, nhận gì và xử lý lỗi ra sao.

Cách hỏi bình thường

Viết tài liệu API này.

Prompt chuyên nghiệp

Chỉ mô tả hợp đồng đã cung cấp. Không tự thêm xác thực, status code hoặc trường dữ liệu; đánh dấu phần cần hỏi thêm.

Thông tin của tôi:
endpoint: {{endpoint}}
đầu vào: {{đầu vào}}
phản hồi: {{phản hồi}}

Yêu cầu đầu ra: Tóm tắt; bảng request/response; ví dụ JSON giả định; lỗi; danh sách đặc tả còn thiếu.

Viết bằng tiếng Việt tự nhiên. Chỉ dùng thông tin được cung cấp. Nếu thiếu dữ liệu quan trọng, hỏi lại; không tự tạo số liệu, nguồn hoặc kết quả đã kiểm chứng.

Kết quả mong đợi

Tóm tắt; bảng request/response; ví dụ JSON giả định; lỗi; danh sách đặc tả còn thiếu.