Each project arrives with its purpose, milestones and first tasks written out. Here is how the first three read.
Inventory of every API endpoint and its consumers
Nobody can evolve an API safely without knowing who calls it, and most teams discover forgotten clients only when a change breaks them. A single list of every endpoint, its owner, its authentication method and the clients seen calling it in the last 30 days turns guesswork into a map. It is also the list every later project in this area works from.
First tasks
- Export the route table from each service or the gateway configuration
- Pull 30 days of access logs and group calls by client identifier
- Mark endpoints with zero traffic as retirement candidates
- Publish the inventory with an owner and a last-updated date
API style guide for resources and naming
Inconsistent APIs cost every client developer time: one endpoint uses camelCase, the next snake_case, one returns a bare array and another wraps it. A short style guide that fixes resource naming, plural nouns, casing, date formats, identifier types and envelope shape means new endpoints look as if one person designed them.
First tasks
- Read two published API style guides and pick one as the base
- List the five inconsistencies most visible in your current endpoints
- Ask the agent to draft house rules with good and bad examples for each
- Agree the guide with the API builders and commit it
One error response format for all endpoints
Client code that handles errors well needs to know where to find a machine-readable code, a human message and the field that failed, every time. Standardising on one shape, such as the problem details format from the IETF, with a stable catalogue of error codes, lets clients write one error handler instead of one per endpoint. It also stops stack traces and database messages leaking to the outside world.
First tasks
- Collect ten real error responses from different endpoints and compare their shapes
- Write the chosen error format and the first twenty error codes
- Build shared middleware that emits the format and add it to one service
- Add a test that fails if a stack trace appears in any response body