قوانین توسعه API
API باید predictable، version-aware و سازگار با response استاندارد پروژه باشد.
قوانین
- response خام و پراکنده ممنوع است
- validation برای همه inputها الزامی است
- pagination برای listها الزامی است
- filter و sort باید whitelist داشته باشند
- authorization باید قبل از دسترسی به داده enforce شود
- errorها باید ساختار استاندارد داشته باشند
Backward Compatibility
تغییرات زیر breaking محسوب میشوند:
- حذف field
- تغییر type field
- تغییر معنای status
- تغییر ساختار pagination
- تغییر کد خطا
Documentation
هر endpoint جدید باید حداقل موارد زیر را مستند کند:
- method و path
- permission
- request fields
- response structure
- errorهای مهم