SKIP TO CONTENT
SEPTIAN.PADLI
← BLOG INDEX
ENGINEERING NOTESPOST / PUBLISHED

A Small Rule for API Boundaries.

If an endpoint needs a paragraph to explain what it returns, the boundary is probably doing too much.

1 MIN READ

This is a rule of thumb, not a law. Clear names and predictable shapes usually make integration work quieter.

// Prefer a resource-shaped answer.
GET /projects/:id/files

// Over a verb with a hidden contract.
GET /getProjectFilesAndMetadata

The goal is not REST purity. It is reducing the amount of context another developer has to reconstruct before they can make a safe change.

#API#BACKEND#DESIGN
# RELATED

KEEP
READING.