Mengapa Desain API Penting?
API adalah kontrak antara backend dan semua klien yang mengonsumsinya. API yang buruk menyebabkan kebingungan, bug, dan technical debt yang sulit diselesaikan.
Prinsip Utama REST yang Sering Dilupakan
- Gunakan noun, bukan verb di endpoint (/users bukan /getUsers)
- HTTP method harus mencerminkan operasi (GET idempotent, POST tidak)
- Status code yang tepat (201 Created, 422 Unprocessable Entity)
- Pagination konsisten di semua resource
- Versioning yang jelas (/v1/users)
Naming Convention
Gunakan kebab-case untuk URL (/user-profiles), camelCase untuk JSON properties, dan konsisten di seluruh API. Dokumentasikan setiap endpoint dengan OpenAPI/Swagger.
Error Handling
Error response harus informatif namun tidak membocorkan detail internal. Format error yang konsisten memudahkan klien menangani berbagai kondisi error.
Kesimpulan
API yang baik adalah investasi jangka panjang – ia mengurangi friction dalam integrasi dan menjadi kebanggaan tim engineering