ভালো API predictable, consistent আর ভুল ব্যবহার করা কঠিন। একবার publish হলে API বদলানো কঠিন, তাই design এ সময় দাও।
REST convention
| Action | Endpoint | Status |
|---|---|---|
| List | GET /v1/orders?status=paid&limit=20 | 200 |
| একটা পড়া | GET /v1/orders/{id} | 200 / 404 |
| তৈরি | POST /v1/orders | 201 + Location header |
| আংশিক update | PATCH /v1/orders/{id} | 200 |
| মোছা | DELETE /v1/orders/{id} | 204 |
| Nested | GET /v1/users/{id}/orders | 200 |
| Action (CRUD নয়) | POST /v1/orders/{id}/cancel | 200 |
- Resource noun, plural; verb URL এ না (
/getOrdersনা)। - একই ধরনের error format সবখানে, যেমন RFC 9457 Problem Details:
{ "type", "title", "status", "detail", "errors": [...] }। - Versioning: URL (
/v1) সবচেয়ে সহজ; breaking change এ নতুন version, পুরনোটা deprecation নোটিশ দিয়ে কিছুদিন রাখো। - OpenAPI spec লিখো বা generate করো; তা থেকে docs আর typed client বানানো যায়।
Pagination
- Offset (
?page=3&limit=20): সহজ, page number দেখানো যায়। কিন্তু বড় offset এ ধীর, আর মাঝে data যোগ হলে item বাদ/দ্বিগুণ হয়। - Cursor (
?after=<last_id>&limit=20): দ্রুত আর stable; infinite scroll, feed আর বড় table এর জন্য সেরা।
SELECT * FROM posts WHERE (created_at, id) < ($1, $2)
ORDER BY created_at DESC, id DESC LIMIT 20;
Idempotency
Network fail করলে client retry করবে। Payment বা order এর মতো POST দুইবার হলে টাকা দুইবার কাটবে। সমাধান: client Idempotency-Key header পাঠাবে; server সেই key আর প্রথম response সংরক্ষণ করে, একই key আবার এলে সেই response ফেরত দেবে।
Rate limiting
- Algorithm: fixed window (সহজ), sliding window (নিখুঁত), token bucket (burst অনুমতি দেয়, সবচেয়ে জনপ্রিয়)।
- একাধিক server থাকলে count Redis এ রাখো। Limit পার হলে 429 +
Retry-Afterheader। - Limit user/API key অনুযায়ী, শুধু IP নয় (একই office এর সবাই এক IP)।
REST vs GraphQL vs gRPC vs tRPC
| Style | শক্তি | দুর্বলতা | কখন |
|---|---|---|---|
| REST | সহজ, HTTP cache, সবাই জানে | Over/under-fetching | Public API, বেশিরভাগ ক্ষেত্রে default |
| GraphQL | Client নিজে field বেছে নেয়, এক endpoint | Caching কঠিন, N+1, complexity | অনেক client, জটিল nested data |
| gRPC | দ্রুত (Protobuf, HTTP/2), streaming, strict contract | Browser এ সরাসরি না | Service-to-service |
| tRPC | End-to-end type safety, schema লাগে না | শুধু TypeScript monorepo | Next.js full stack app |
Real-time আর async communication
- WebSocket: দুইদিকে persistent connection; scale করতে Redis pub/sub বা sticky session লাগে।
- SSE: server → client stream, সাধারণ HTTP, auto-reconnect।
- Webhook: অন্য system কে event জানানো; signature, retry আর idempotent receiver লাগে।
- Message queue (RabbitMQ, SQS, Kafka): service গুলোকে আলাদা (decouple) করে, আর spike সামলায়।
Interview প্রশ্ন
- একটা blog/e-commerce এর REST API design করো (endpoint, status code, error format)।
- Offset আর cursor pagination এর পার্থক্য?
- Idempotency কী? Payment API তে কীভাবে নিশ্চিত করবে?
- Rate limiter design করো (token bucket + Redis)।
- REST না GraphQL: কোন ক্ষেত্রে কোনটা?
- Breaking change ছাড়া API কীভাবে বদলাবে?