Viết tài liệu API chuẩn RESTful

Mô tả: Tạo tài liệu chi tiết cho một API RESTful dựa trên yêu cầu cụ thể. Đảm bảo tài liệu dễ hiểu, bao gồm các endpoint, phương thức, tham số và ví dụ. Trình bày tài liệu theo định dạng có cấu trúc, phù hợp với tiêu chuẩn như OpenAPI.

Tags: API documentationRESTful APIOpenAPIdeveloper tools

Nội dung Prompt

Đảm nhận vai trò của một nhà phát triển API được giao nhiệm vụ tạo tài liệu cho một API RESTful. Mục tiêu chính là cung cấp tài liệu rõ ràng, dễ hiểu để các nhà phát triển khác có thể sử dụng API hiệu quả. Hãy làm theo các bước sau:
 1. Xác định các endpoint chính của API và chức năng của chúng.
 2. Mô tả các phương thức HTTP được sử dụng (GET, POST, PUT, DELETE, v.v.).
 3. Liệt kê các tham số (query, body, header) và định dạng dữ liệu đầu vào/đầu ra.
 4. Cung cấp ví dụ về yêu cầu và phản hồi cho mỗi endpoint.
 5. Đảm bảo tài liệu tuân thủ các tiêu chuẩn như OpenAPI hoặc Swagger.
 6. Bao gồm các thông tin về xác thực, giới hạn tốc độ và xử lý lỗi.
#THÔNG TIN VỀ TÔI:
Loại API: [MÔ TẢ LOẠI API]
Đối tượng sử dụng: [ĐỐI TƯỢNG SỬ DỤNG]
Ngôn ngữ lập trình: [NGÔN NGỮ LẬP TRÌNH]
Yêu cầu đặc biệt: [YÊU CẦU ĐẶC BIỆT]
#YÊU CẦU QUAN TRỌNG NHẤT!:
Trình bày tài liệu API theo định dạng có cấu trúc với các phần: Tên endpoint, Phương thức HTTP, Tham số, Ví dụ yêu cầu/phản hồi. Bao gồm ít nhất 5 endpoint trong tài liệu.

Mẹo khi sử dụng

- Sử dụng công cụ như Swagger Editor để tạo tài liệu API chuẩn hóa. - Đảm bảo ví dụ yêu cầu/phản hồi rõ ràng và thực tế. - Bao gồm mô tả ngắn gọn về mục đích của từng endpoint để tăng tính dễ hiểu.

Ví dụ

Ví dụ đầu vào #THÔNG TIN VỀ TÔI: Loại API: API quản lý sản phẩm Đối tượng sử dụng: Nhà phát triển nội bộ Ngôn ngữ lập trình: Node.js Yêu cầu đặc biệt: Hỗ trợ xác thực JWT và định dạng JSON.