正在加载内容...

963963 Chat Guide Portal Independent coverage of news

API Design in Practice: Lessons From Real Deployments

By Robert Hayes · · 1277 words
API Design in Practice: Lessons From Real Deployments

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.

Teams working on backup strategy 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 backup strategy. Consider backup strategy specifically. Every abstraction you add is a place where behaviour can differ from intent.

In practice, backup strategy behaves differently: A queue smooths spikes but also hides how far behind you are. Retries without jitter turn a small outage into a large one. The same reasoning holds for backup strategy. For backup strategy, the constraint matters more than the feature list. Separating the reads from the writes buys room to change either side.

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.

In practice, data pipelines behaves differently: A queue smooths spikes but also hides how far behind you are. Retries without jitter turn a small outage into a large one. The same reasoning holds for data pipelines. For data pipelines, the constraint matters more than the feature list. Separating the reads from the writes buys room to change either side.

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

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

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

A boundary can change as a person’s comfort, health, relationship or circumstances change. Checking in does not mean asking for repeated permission in a way that becomes pressure; it means making space for an honest answer. Agree on a simple way to pause, such as a clear word or phrase, and treat it as a stop signal. If someone changes their mind, the other person should stop without demanding an explanation.

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

Consider edge caching specifically. Serving static bytes is the cheapest thing you can do at the edge. Edge Caching: A schema is an interface; changing it is a migration, not an edit. Track the denominator as carefully as the numerator. That applies to edge caching as well.

Cloud Infrastructure: 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 cloud infrastructure as well. In practice, cloud infrastructure behaves differently: Costs usually concentrate in a small number of operations, so find those first.

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

Edge Caching: The first thing to settle is the failure mode, not the happy path. Edge Caching: Measurements taken once are anecdotes; you need a baseline that repeats. Edge Caching: Costs usually concentrate in a small number of operations, so find those first.

Log Analysis: The first thing to settle is the failure mode, not the happy path. Log Analysis: Measurements taken once are anecdotes; you need a baseline that repeats. Log Analysis: Costs usually concentrate in a small number of operations, so find those first.

In practice, cloud infrastructure behaves differently: Configurations should be reviewable in a diff, not only in a console. The best time to add an index is before the table gets large. The same reasoning holds for cloud infrastructure. For cloud infrastructure, the constraint matters more than the feature list. Failures are usually correlated, so plan for the shared dependency.

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

Talk about privacy, too. Clarify whether intimate messages or images may be saved, shown to someone else, or shared online. Do not assume that permission to create or send an image includes permission to distribute it. Laws concerning intimate images differ across countries, and sharing without consent may have serious consequences. If you do not want an image made or shared, state that plainly.

Log Analysis: A queue smooths spikes but also hides how far behind you are. Log Analysis: Retries without jitter turn a small outage into a large one. Log Analysis: Separating the reads from the writes buys room to change either side.

Schema Migration: The first thing to settle is the failure mode, not the happy path. Schema Migration: Measurements taken once are anecdotes; you need a baseline that repeats. Schema Migration: Costs usually concentrate in a small number of operations, so find those first.

Pressure can also interfere with a free choice. Repeated requests after a refusal, threats, intimidation or using someone’s dependence or vulnerability to influence them are not respectful ways to seek agreement. Differences in authority or power can make it harder for a person to refuse, even without an explicit threat. A responsible check-in leaves room for an honest no and does not punish, shame or bargain with someone for setting a boundary.

API Design: Serving static bytes is the cheapest thing you can do at the edge. API Design: A schema is an interface; changing it is a migration, not an edit. API Design: Track the denominator as carefully as the numerator.

When the parcel arrives, examine the exterior and any visible seal before discarding the packaging. If the wrong item arrives or the parcel appears damaged, photograph the package and contact the seller through its published support channel before removing labels or packing materials. Keep the order confirmation and any warranty information. Product materials, cleaning instructions and care requirements are found in the product documentation, not reliably inferred from a shipping box; follow the manufacturer’s instructions and retain relevant packaging if a return requires it.

A design that cannot be rolled back is a design that cannot be changed safely. That applies to cost controls as well. In practice, cost controls 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 cost controls.

Related reading