963963Chat Independent coverage of news

API Design Explained Without the Jargon

By David Kim · · 1283 words
API Design Explained Without the Jargon

Consider data pipelines specifically. You can often replace a coordination problem with an idempotency key. Data Pipelines: Anything that grows without a bound will eventually hit one. Documentation that is not tested tends to describe the previous version. That applies to data pipelines as well.

Before raising the subject, consider what matters to you. A boundary might concern whether you want a particular kind of sexual contact, when you feel ready, what privacy means to you, or what safer-sex measures you expect. It can also be a condition: for example, you may want to discuss contraception or STI testing before sexual activity. You do not need to have a complete list or a perfectly polished explanation. Start with the limit that feels most relevant now.

Consider content delivery specifically. The interesting number is not the average, it is the 99th percentile. Content Delivery: Adding a cache in front of a slow query is a fix; fixing the query is a cure. Every abstraction you add is a place where behaviour can differ from intent. That applies to content delivery as well.

Schema Migration: You can often replace a coordination problem with an idempotency key. Schema Migration: Anything that grows without a bound will eventually hit one. Schema Migration: Documentation that is not tested tends to describe the previous version.

Consider access control specifically. A design that cannot be rolled back is a design that cannot be changed safely. Access Control: Latency budgets are easier to defend when every hop has a stated ceiling. Caching helps only until the invalidation rules become the bottleneck. That applies to access control as well.

Monitoring Alerts: The first thing to settle is the failure mode, not the happy path. Measurements taken once are anecdotes; you need a baseline that repeats. That applies to monitoring alerts as well. In practice, monitoring alerts behaves differently: Costs usually concentrate in a small number of operations, so find those first.

A boundary is a limit a person sets around their own body, time, privacy or emotional wellbeing. In a relationship, it might concern which kinds of physical contact feel welcome, whether a person wants to use a barrier method during sex, how personal information is shared, or when they need time alone. Boundaries can be broad, but clear examples are easier to understand and respect.

A design that cannot be rolled back is a design that cannot be changed safely. The same reasoning holds for queue design. For queue design, the constraint matters more than the feature list. Latency budgets are easier to defend when every hop has a stated ceiling. Teams working on queue design usually discover this the hard way. Caching helps only until the invalidation rules become the bottleneck.

Observability: Periodic jobs should be safe to run twice, because they will be. You rarely need a new component to fix a boundary problem. That applies to observability as well. In practice, observability behaves differently: The signal you want is often already logged, just not aggregated.

Content Delivery: If the rollback plan needs a meeting, it is not a rollback plan. Content Delivery: Small pages that stay small are easier to keep fast than large ones made fast. Content Delivery: Write the invariant down; otherwise it lives only in someone's memory.

You can often replace a coordination problem with an idempotency key. The same reasoning holds for api design. For api design, the constraint matters more than the feature list. Anything that grows without a bound will eventually hit one. Teams working on api design usually discover this the hard way. Documentation that is not tested tends to describe the previous version.

Teams working on load balancing usually discover this the hard way. You can often replace a coordination problem with an idempotency key. Anything that grows without a bound will eventually hit one. This is most visible in load balancing. Consider load balancing specifically. Documentation that is not tested tends to describe the previous version.

For release process, the constraint matters more than the feature list. Configurations should be reviewable in a diff, not only in a console. Teams working on release process usually discover this the hard way. The best time to add an index is before the table gets large. Failures are usually correlated, so plan for the shared dependency. This is most visible in release process.

API Design: A design that cannot be rolled back is a design that cannot be changed safely. API Design: Latency budgets are easier to defend when every hop has a stated ceiling. API Design: Caching helps only until the invalidation rules become the bottleneck.

Monitoring Alerts: Periodic jobs should be safe to run twice, because they will be. You rarely need a new component to fix a boundary problem. That applies to monitoring alerts as well. In practice, monitoring alerts behaves differently: The signal you want is often already logged, just not aggregated.

Schema Migration: Configurations should be reviewable in a diff, not only in a console. Schema Migration: The best time to add an index is before the table gets large. Schema Migration: Failures are usually correlated, so plan for the shared dependency.

Crawl Budget: The interesting number is not the average, it is the 99th percentile. Crawl Budget: Adding a cache in front of a slow query is a fix; fixing the query is a cure. Crawl Budget: Every abstraction you add is a place where behaviour can differ from intent.

Search Indexing: You can often replace a coordination problem with an idempotency key. Search Indexing: Anything that grows without a bound will eventually hit one. Search Indexing: Documentation that is not tested tends to describe the previous version.

Teams working on data pipelines usually discover this the hard way. The interesting number is not the average, it is the 99th percentile. Adding a cache in front of a slow query is a fix; fixing the query is a cure. This is most visible in data pipelines. Consider data pipelines specifically. Every abstraction you add is a place where behaviour can differ from intent.

Use direct language and describe the limit in practical terms. For example: “I want to use a condom every time we have sex,” or “Please ask before taking or sharing photos of me.” A person can briefly explain why, but they do not have to prove that a boundary is reasonable. If the limit is not yet clear to them, they can say so and ask to pause while they decide.

A design that cannot be rolled back is a design that cannot be changed safely. That applies to storage tiers as well. In practice, storage tiers behaves differently: Latency budgets are easier to defend when every hop has a stated ceiling. Caching helps only until the invalidation rules become the bottleneck. The same reasoning holds for storage tiers.

For content delivery, the constraint matters more than the feature list. A queue smooths spikes but also hides how far behind you are. Teams working on content delivery usually discover this the hard way. Retries without jitter turn a small outage into a large one. Separating the reads from the writes buys room to change either side. This is most visible in content delivery.

Backup Strategy: Periodic jobs should be safe to run twice, because they will be. Backup Strategy: You rarely need a new component to fix a boundary problem. Backup Strategy: The signal you want is often already logged, just not aggregated.

API Design: If a metric has no owner, it will drift until it causes an incident. API Design: The cheapest optimisation is usually removing work nobody asked for. API Design: Aggregating at write time trades flexibility for predictable read cost.

Related reading