正在加载内容...

963963 Chat News Review Independent coverage of news

Common Mistakes When Evaluating API Design

By Nina Alvarez · · 1248 words
Common Mistakes When Evaluating API Design

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.

Cloud Infrastructure: 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 cloud infrastructure as well. In practice, cloud infrastructure behaves differently: The signal you want is often already logged, just not aggregated.

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

Configurations should be reviewable in a diff, not only in a console. This is most visible in schema migration. Consider schema migration specifically. 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.

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

For schema migration, the constraint matters more than the feature list. The first thing to settle is the failure mode, not the happy path. Teams working on schema migration 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 schema migration.

Consider api design specifically. If the rollback plan needs a meeting, it is not a rollback plan. API Design: 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 api design as well.

In practice, api design behaves differently: The first thing to settle is the failure mode, not the happy path. Measurements taken once are anecdotes; you need a baseline that repeats. The same reasoning holds for api design. For api design, the constraint matters more than the feature list. Costs usually concentrate in a small number of operations, so find those first.

The interesting number is not the average, it is the 99th percentile. The same reasoning holds for schema migration. For schema migration, 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 schema migration usually discover this the hard way. Every abstraction you add is a place where behaviour can differ from intent.

Load Balancing: A queue smooths spikes but also hides how far behind you are. Retries without jitter turn a small outage into a large one. That applies to load balancing as well. In practice, load balancing behaves differently: Separating the reads from the writes buys room to change either side.

In practice, log analysis behaves differently: Periodic jobs should be safe to run twice, because they will be. You rarely need a new component to fix a boundary problem. The same reasoning holds for log analysis. For log analysis, the constraint matters more than the feature list. The signal you want is often already logged, just not aggregated.

Teams working on api design usually discover this the hard way. A design that cannot be rolled back is a design that cannot be changed safely. Latency budgets are easier to defend when every hop has a stated ceiling. This is most visible in api design. Consider api design specifically. Caching helps only until the invalidation rules become the bottleneck.

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

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

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

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

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

Log Analysis: If a metric has no owner, it will drift until it causes an incident. The cheapest optimisation is usually removing work nobody asked for. That applies to log analysis as well. In practice, log analysis behaves differently: Aggregating at write time trades flexibility for predictable read cost.

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

Periodic jobs should be safe to run twice, because they will be. This is most visible in storage tiers. Consider storage tiers specifically. You rarely need a new component to fix a boundary problem. Storage Tiers: The signal you want is often already logged, just not aggregated.

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

A respectful response may include questions asked to understand, a clear acceptance of the limit, or a request to discuss a separate preference. A partner does not have to share your boundary to respect it. By contrast, repeated bargaining after you have said no, guilt, threats, ridicule, or continuing after you ask to stop are not respectful ways to handle a boundary. You are not responsible for making another person approve of your limit.

Before testing, a person can ask which infections are being checked, which samples will be taken, when results are expected and how the service will contact them. They can also ask about confidentiality and how records are handled. Privacy rules, including exceptions and rules for different ages, vary by country and service; it is reasonable to ask the clinic to explain them before sharing information.

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

Related reading