REST / OpenAPI Contract Designer
Thiết kế API contract chuẩn OpenAPI 3.1: resource, endpoint, schema, mã lỗi, phân trang, versioning và idempotency.
REST / OpenAPI Contract Designer là một Prompt (micro-prompt có biến) thuộc nhóm System Design & AI, giúp thiết kế API contract chuẩn OpenAPI 3.1: resource, endpoint, schema, mã lỗi, phân trang, versioning và idempotency. Cần 2 đầu vào: Miền nghiệp vụ; Use case chính. Dùng trực tiếp với ChatGPT, Claude, Cursor/Windsurf hoặc xuất SKILL.md cho Claude Code, OpenClaw, Hermes.
Biến (2)
Bạn là API Architect. Thiết kế API contract cho: MIỀN NGHIỆP VỤ: Hệ thống đặt lịch hẹn cho chuỗi spa USE CASES: Khách xem lịch trống; đặt lịch; hủy/đổi lịch; nhân viên xác nhận; gửi nhắc lịch Đầu ra: 1. Danh sách resource và quan hệ. 2. Bảng endpoint: method – path – mô tả – auth – idempotent? 3. Đặc tả OpenAPI 3.1 (YAML) cho 3 endpoint quan trọng nhất, gồm schema request/response và ví dụ. 4. Chuẩn lỗi thống nhất (RFC 9457 Problem Details) với 5 mã lỗi nghiệp vụ. 5. Chiến lược phân trang, lọc, sắp xếp; versioning; rate limit; Idempotency-Key cho thao tác tạo. 6. Webhook events cần phát ra và payload mẫu.
Câu hỏi thường gặp
REST / OpenAPI Contract Designer dùng để làm gì?
REST / OpenAPI Contract Designer là một Prompt (micro-prompt có biến) thuộc nhóm System Design & AI, giúp thiết kế API contract chuẩn OpenAPI 3.1: resource, endpoint, schema, mã lỗi, phân trang, versioning và idempotency. Cần 2 đầu vào: Miền nghiệp vụ; Use case chính. Dùng trực tiếp với ChatGPT, Claude, Cursor/Windsurf hoặc xuất SKILL.md cho Claude Code, OpenClaw, Hermes.
Cần chuẩn bị những thông tin đầu vào nào?
Miền nghiệp vụ ({{DOMAIN}}); Use case chính ({{USE_CASES}}). Mỗi biến có ô nhập riêng và giá trị mẫu để thử ngay.
Dùng REST / OpenAPI Contract Designer với ChatGPT, Claude hoặc Cursor như thế nào?
1. Điền biến đầu vào: Điền 2 biến: Miền nghiệp vụ; Use case chính. 2. Xem trước kết quả: Kiểm tra live preview: phần đã điền được tô xanh, biến còn trống được tô vàng. 3. Copy cho công cụ AI: Bấm Copy cho ChatGPT/Claude, Copy .cursorrules cho Cursor/Windsurf, hoặc tải SKILL.md cho Claude Code / OpenClaw / Hermes. 4. Chạy và tinh chỉnh: Dán vào công cụ AI, đánh giá đầu ra và lưu lại phiên bản giá trị biến hiệu quả nhất bằng Direct link.
Có thể chia sẻ prompt đã điền sẵn cho đồng đội không?
Có. Bấm "Direct link" để copy URL kèm giá trị biến; người nhận mở link sẽ thấy form đã được điền sẵn.
Liên quan
- Skill
Quality gate bắt buộc trước khi agent xuất bản, commit hoặc gửi nội dung: quét và che API key, token, mật khẩu, PII.
System Design & AI3 gatesChi tiết - Prompt
Phân tầng tác vụ thông minh: Tách phản xạ nhanh (System 1) và suy luận logic sâu (System 2) nhằm tối ưu chi phí token theo định lý Jevons Paradox.
System Design & AI1 biếnChi tiết - Prompt
Prompt tự động tạo các ví dụ Input-Output mẫu (Few-Shot examples) để đưa vào AI Studio giúp Gemini hiểu rõ các task phức tạp.
System Design & AI0 biếnChi tiết