Audit intermediate Works with: Any AI

REST API Design Review

Table output Has example

Check resources, errors and consistency.

The Open buttons send the prompt text as currently shown below to that site only when you click. Fill in the placeholders first.

Review a REST API design. Paste the endpoint list with methods, example requests and responses and error formats: [API_DESIGN]. Client types and use cases: [CLIENTS_USE_CASES]. Versioning approach: [VERSIONING].

Check naming consistency, use of methods and status codes, pagination and filtering, idempotence of writes, error shape, authentication and authorisation placement, and long-running operations. Identify designs that will cause breaking changes later.

Return a table with Endpoint, Issue, Severity (red, amber, green) and Better design, and a style guide of ten rules for future endpoints.

Also provide a short example of the same endpoint before and after the proposed changes, a list of breaking changes with a deprecation plan, and a checklist for reviewing new endpoints in future pull requests.

Also compare the current design with a simpler alternative that has fewer endpoints, and say what would be gained and lost. Suggest how to document error codes, with a table of code, meaning and the action the client should take. Finish with the one inconsistency most likely to confuse developers.

Then write the API style guide and migration plan that follow from the review. Include rules for resource naming, pluralisation, nesting depth, query parameters for filtering and sorting, pagination format, status code usage, error object structure, date and money formats, idempotency keys and versioning. For each rule, give a good and a bad example from invented endpoints. Provide a migration plan that introduces improvements without breaking clients: add new fields first, support both old and new behaviour, announce deprecations with dates, monitor usage and remove only after the traffic is gone. Create a review checklist for new endpoints and a template for a design proposal of one page. Suggest tests that check the contract, including error responses. Add a communication plan to partner developers with a changelog and sandbox access. Document decisions so that future maintainers know why.

Fill in before use

Optional: type your details and the prompt above updates. Nothing is saved or sent.

Replace each bracketed placeholder with your own details, then paste into Any AI or another assistant.

Endpoint review (invented)
POST /getOrders: verb in path and wrong method. Better GET /orders. Severity amber.
GET /orders: returns all rows. No pagination. Red. Add limit and cursor.
Errors: 200 with {"error": "not found"}. Red. Use 404 with a standard error object.
Dates: three formats across endpoints. Amber. Use ISO 8601.
POST /payments has no idempotency key; double submit creates two payments. Red.
Style rules (sample): plural nouns, filters as query parameters, errors with code, message and request id.
Migration: add new behaviour beside the old, announce deprecation with a date, monitor usage, remove later.

• audit