mufassall

Communication / 1 / 6

API styles

One screen of a food-delivery app, "My orders", built with REST, then GraphQL, with gRPC between services. Where each style fetches too much or too little, and the habits every API needs: cursor pagination, versioning and idempotency keys.

  • 12 min
  • Beginner
  • 12 steps
Calls per screen
1
Screen load
180 ms
Data per screen
0.1 MB
Double orders
0 /day
Open in Lab

  • request
  • reply
  • redelivery
  • duplicate
  • lost

Numbers are a model scenario, not measurements

The real request

Phone app → REST API

Request

GET /v1/orders?limit=20 HTTP/1.11
Host: api.example.com

Response

HTTP/1.1 200 OK
{
  "data": 2[
    {
      "id": "ord_981",
      "status": "delivered",
      "total": 84000,
      "restaurant_id": 3"r_7",
      "address": { ... },
      "items": 4[ ... ]
    }
  ]
}
  1. GET — Reading only. Safe to repeat and easy to cache.
  2. data — The list itself. Keeping it under a key leaves room for paging info next to it.
  3. restaurant_id — Only an ID. The screen needs the name, which is not here.
  4. items — Bulky fields the screen never shows, sent on every load anyway.

Build it yourselfCheat sheetCompare lessons

Course: 74 lessons
  1. 01 Foundations

    1. The life of a request
    2. Latency and throughput
    3. Napkin math
  2. 02 Scaling

    1. Scaling up vs scaling out
    2. Load balancing
    3. Stateless servers
    4. Caching
    5. Cache invalidation
    6. CDN and edge caching
  3. 03 Data & storage

    1. SQL and NoSQL
    2. Database indexes
    3. Geo search: who is nearby
    4. Full-text search
    5. Vector search
    6. Storage engines: B-tree and LSM
    7. Bloom filters
    8. Database replication
    9. Sharding
    10. Consistent hashing
    11. Unique IDs
    12. CAP: when the link breaks
    13. Consensus and leader election
    14. Transactions
    15. File uploads
  4. 04 Communication

    1. API styles
    2. Message queues
    3. Pub/sub and event logs
    4. Real-time updates
    5. Reliable callbacks
    6. Sending webhooks reliably
  5. 05 Reliability

    1. Redundancy and failover
    2. Rate limiting
    3. Timeouts and retries
    4. Observability
    5. SLOs and error budgets
    6. Backpressure
  6. 06 Architecture

    1. Microservices
    2. Service discovery
    3. Sagas and the outbox
    4. Change data capture (CDC)
    5. Transactional outbox
    6. Distributed locks
    7. Batch vs stream
    8. Multi-tenancy
    9. Event sourcing
  7. 07 Security

    1. Authentication
    2. Authorization
    3. Encryption and secrets
    4. Secrets management
  8. 08 Shipping

    1. Testing
    2. CI/CD: from commit to production
    3. Zero-downtime migrations
    4. Feature flags
  9. 09 Whole systems

    1. From requirements to design
    2. Design a URL shortener
    3. Design a news feed
    4. Design a chat
    5. Design a video streaming site
    6. Design search autocomplete
    7. Design a job scheduler
  10. 10 Business processes

    1. Payment gateway
    2. Money and rounding
    3. Double-entry ledger
    4. Payment reconciliation
    5. Subscription billing
    6. Electronic digital signature
    7. Document lifecycle
    8. Audit log
    9. Notification delivery
    10. Bulk import
    11. Refunds and chargebacks
    12. Gapless document numbering
  11. 11 Case studies

    1. Case: how Discord stores messages
    2. Case: Figma multiplayer editing