Dorian — Đại lý tài liệu API AI

Bạn nhận được gì

• → Tham khảo đầy đủ điểm cuối — mọi điểm cuối được tài liệu hóa với phương thức HTTP, đường dẫn, mô tả, bảng tham số, thân yêu cầu, phản hồi thành công và mã lỗi để nhà phát triển có mọi thứ cần thiết mà không phải đọc mã nguồn
• → Hướng dẫn xác thực — phương pháp xác thực được tài liệu hóa với cách lấy thông tin đăng nhập, cách đưa vào yêu cầu với ví dụ định dạng header, và ví dụ yêu cầu đã xác thực đầy đủ để nhà phát triển không bị tắc trong vài phút thay vì vài giờ
• → Ví dụ yêu cầu và phản hồi thực tế — ví dụ curl và các thân JSON với giá trị trông thật cho mọi điểm cuối, không phải chuỗi giữ chỗ, để nhà phát triển có thể sao chép, dán và chạy ngay lập tức
• → Tham khảo mã lỗi — bảng lỗi đầy đủ bao gồm mọi mã trạng thái API trả về với mô tả và hướng dẫn xử lý để nhà phát triển có thể xử lý lỗi mà không cần tạo phiếu hỗ trợ
• → Hướng dẫn khởi động nhanh cho nhà phát triển — từng bước từ con số không đến cuộc gọi API thành công đầu tiên trong chưa đầy 10 phút, phần có giá trị cao nhất cho bất kỳ nhà phát triển nào bắt đầu tích hợp
• → Định dạng linh hoạt — xuất ra Markdown cho GitHub hoặc các trang tài liệu, OpenAPI 3.0 YAML cho Swagger UI hoặc Redoc, hoặc văn bản có cấu trúc đơn giản cho Confluence và Notion — bất kỳ định dạng nào nhóm bạn sử dụng

Cách cài đặt

Tải cả hai tệp → mở Claude → dán nội dung của dorian-api-documentation-agent.md vào Hướng dẫn Dự án hoặc prompt hệ thống của bạn → dán prompt kích hoạt vào cuộc trò chuyện → Dorian sẽ đặt câu hỏi từng cái một và tạo ra tài liệu API hoàn chỉnh, chuyên nghiệp sẵn sàng để xuất bản. Hoạt động với Claude (khuyến nghị), ChatGPT hoặc bất kỳ AI chat nào chấp nhận prompt hệ thống.