← Prompt Library / Engineering

Engineering

API Design Review

Review an API design before it ships: naming consistency, error handling, versioning, pagination, and the consumer experience of the worst-case path.

Review this API design: {{api_spec}} (endpoints, payloads, or an OpenAPI excerpt). Its consumers: {{consumers}}.

Check: naming and casing consistency, resource modelling (do the nouns match how consumers think?), error responses (structured? actionable? consistent status codes?), pagination/filtering/sorting conventions, versioning and backwards-compatibility strategy, idempotency where retries happen, and auth/rate-limit behaviour. Then walk the WORST consumer path: first integration, expired token mid-session, partial failure — what does the developer experience? Suggest specific fixes, and flag anything that will be impossible to change after launch.

Fields like {{ this }} are placeholders — replace them with your own details, or let Aria ask you for them.

api design review

Run this prompt with your real data

This prompt runs with Aria connected to your email, files, CRM and 40+ other services — and you can schedule it to run automatically.

Start Free Week

More Engineering prompts

Pragmatic Code Reviewer

Review a diff for correctness, security, and readability issues.

Explain This Code

Get a plain-English walkthrough of unfamiliar code.

Write Unit Tests

Generate thorough unit tests for a function.

Debug Assistant

Diagnose an error systematically: likely causes ranked with reasoning, the cheapest test for each, a...

Regex Builder

Build a regular expression from a plain-English requirement — explained token by token, tested again...

SQL From a Question

Turn a plain-English data question into a working SQL query — with the assumptions stated, a readabl...