Mọi 5xx có nên retry không?
Không tự động. Cần xem operation có safe để lặp không, provider có coi lỗi transient không và ambiguous side effect có cần reconcile trước không.
D2 Automation Knowledge
Checklist REST API Integration cho Production
Các control D2 kiểm tra trước khi coi API workflow production-ready: auth, pagination, limit, validation, timeout, retry, schema drift và auditability.
Biên soạn bởi: D2 Automation SystemsRà soát bởi: D2 Systems EngineeringXuất bản: 2026-08-21Cập nhật: 2026-08-21
Câu trả lời ngắn
Câu trả lời thực tế
API integration production không chỉ là nhận được HTTP 200. Nó cần credential lifecycle, request/response validation, pagination, rate-limit handling, timeout, retry classification, idempotency khi có side effect, schema-drift detection, durable error context và observability. Integration contract cũng phải nói rõ điều gì xảy ra khi một hệ thống unavailable.
Engineering model
Reliable API integration = contract + auth + validation + rate control + retry/idempotency + observability + recovery
01 / Design rule
Authentication là một lifecycle
OAuth token hết hạn, API key rotate và scope thay đổi. Credential nên nằm ngoài workflow content, có refresh/rotation behavior và alert auth failure thay vì retry mù.
02 / Design rule
Pagination và rate limit ảnh hưởng correctness
Chỉ fetch page đầu có thể nhìn như thành công nhưng âm thầm mất record. Cần page/cursor termination rule, respect provider limit và checkpoint long pull để retry không lặp phần đã xong.
03 / Design rule
Validate cả hai phía contract
Validate outbound payload trước khi gửi và critical inbound field trước khi dùng. Schema drift nên trở thành exception nhìn thấy ngay, không phải null chạy qua năm node rồi mới fail.
04 / Design rule
Thiết kế cho ambiguous failure
Timeout không chứng minh remote system chưa làm gì. Với call có side effect, query bằng idempotency/business key hoặc reconcile remote state trước khi lặp operation.
Checklist triển khai
Các câu hỏi cần chốt trước khi gọi workflow là production-ready.
- Document auth/scope
- Implement pagination/cursor
- Respect 429/rate header
- Đặt connect/read timeout
- Validate request/response schema
- Side effect phải idempotent
- Persist error context/correlation ID
- Monitor schema/auth/rate-limit failure
FAQ
API secret nên nằm ở đâu?
Trong credential/secret storage của platform hoặc secret manager, không embed trong exported workflow JSON, source file hay public case-study evidence.
Tiêu chuẩn evidence
Architecture knowledge, implementation evidence và production outcome là các mức claim khác nhau.
D2 công khai các boundary này. Methodology page giải thích evidence cần có trước khi một hệ thống được mô tả là implemented, validated hoặc production-backed.
Xem methodology về evidenceCase study liên quan
Xem engineering decision được áp dụng trong các case study của D2.
Áp dụng framework