正在加载内容...

963963 Chat Review Portal Independent coverage of news

API Design: A Practical Overview

By James Whitfield · · 1207 words
API Design: A Practical Overview

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

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

Serving static bytes is the cheapest thing you can do at the edge. That applies to data pipelines as well. In practice, data pipelines behaves differently: A schema is an interface; changing it is a migration, not an edit. Track the denominator as carefully as the numerator. The same reasoning holds for data pipelines.

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

Warranty terms may exclude damage caused by immersion, unapproved cleaners, heat or disassembly. Read the terms while the product is new, and keep the order confirmation, instructions and any messages from the seller. If a product needs service, contact the seller or maker before returning it; they can explain cleaning requirements, packaging and whether accessories should be included. Do not mail a product unless the return process authorizes it.

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

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

Teams working on search indexing usually discover this the hard way. Serving static bytes is the cheapest thing you can do at the edge. A schema is an interface; changing it is a migration, not an edit. This is most visible in search indexing. Consider search indexing specifically. Track the denominator as carefully as the numerator.

The interesting number is not the average, it is the 99th percentile. That applies to api design as well. In practice, api design behaves differently: 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. The same reasoning holds for api design.

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

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

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.

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

It can help to prepare a short sentence and a next step. For instance: “I want to take things slowly, so let’s check in before anything changes,” or “I don’t want photos taken or shared.” If you are unsure what you want, say so. “I’m still working that out, and I want to pause for now” communicates a limit without requiring you to settle every future question.

Configurations should be reviewable in a diff, not only in a console. This is most visible in access control. Consider access control specifically. The best time to add an index is before the table gets large. Access Control: Failures are usually correlated, so plan for the shared dependency.

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

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

Consider rate limiting specifically. If the rollback plan needs a meeting, it is not a rollback plan. Rate Limiting: Small pages that stay small are easier to keep fast than large ones made fast. Write the invariant down; otherwise it lives only in someone's memory. That applies to rate limiting as well.

The interesting number is not the average, it is the 99th percentile. The same reasoning holds for crawl budget. For crawl budget, the constraint matters more than the feature list. Adding a cache in front of a slow query is a fix; fixing the query is a cure. Teams working on crawl budget usually discover this the hard way. Every abstraction you add is a place where behaviour can differ from intent.

If a metric has no owner, it will drift until it causes an incident. This is most visible in content delivery. Consider content delivery specifically. The cheapest optimisation is usually removing work nobody asked for. Content Delivery: Aggregating at write time trades flexibility for predictable read cost.

Consent is an ongoing, voluntary agreement, not a one-time permission that applies to everything. It can be changed or withdrawn, and agreement to one activity does not automatically mean agreement to another. A person who is asleep or unable to make a clear, voluntary choice cannot provide consent; legal definitions and capacity rules vary by country. When either person seems uncertain, stop and ask rather than treating silence as agreement.

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

For load balancing, the constraint matters more than the feature list. The first thing to settle is the failure mode, not the happy path. Teams working on load balancing usually discover this the hard way. Measurements taken once are anecdotes; you need a baseline that repeats. Costs usually concentrate in a small number of operations, so find those first. This is most visible in load balancing.

Serving static bytes is the cheapest thing you can do at the edge. That applies to schema markup as well. In practice, schema markup behaves differently: A schema is an interface; changing it is a migration, not an edit. Track the denominator as carefully as the numerator. The same reasoning holds for schema markup.

Related reading