backend-api-design-review

Review HTTP and GraphQL API design for correctness and consistency.

3|Updated Mar 10, 2026
One-click install
npx skills add https://github.com/infraspecdev/tesseract --skill backend-api-design-review
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: backend-api-design-review
Source: https://github.com/infraspecdev/tesseract/tree/main/shield/skills/backend/api-design-review
Command: npx skills add https://github.com/infraspecdev/tesseract --skill backend-api-design-review

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you catch API design issues early by reviewing HTTP and GraphQL endpoints for correctness, consistency, and contract quality before they reach clients.

Core Features & Use Cases

  • Endpoint Semantics Review: Checks resource-oriented paths, HTTP method usage, status codes, and idempotency.
  • Contract Consistency Review: Evaluates versioning, error response shape, pagination, filtering, validation, and representation consistency across endpoints.
  • Use Case: Use this Skill when auditing a new controller, route handler, or resolver to find issues that would break client expectations or make the API hard to evolve.

Quick Start

Review the API handlers in scope and summarize any design issues grouped by endpoint.

Frequently Asked Questions about backend-api-design-review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I review REST API design for correctness and consistency before release?

Review REST API design by verifying resource modeling, HTTP method usage, status codes, and idempotency to catch endpoint issues before they reach clients. This ensures correct HTTP semantics and consistent contract quality across controllers and route handlers.

What is the best way to audit GraphQL resolvers for design flaws?

Auditing GraphQL resolvers involves evaluating versioning, error response shapes, pagination, filtering, and validation to find issues that would break client expectations. This resolver review ensures representation consistency and contract quality during implementation.

How do I check HTTP status codes and idempotency in my API controllers?

Checking HTTP status codes and idempotency in API controllers involves verifying HTTP semantics and resource modeling during endpoint audits. This process confirms that route handlers return correct status codes and maintain safe, idempotent operations for reliable client interactions.

Does this API review cover pagination, filtering, and error shapes for contract changes?

This API review covers pagination, filtering, and error shapes for contract changes by evaluating versioning and representation consistency across endpoints. It ensures that validation and error response shapes remain uniform during endpoint audits and contract modifications.

Why does my API design break client expectations during contract changes?

API design breaks client expectations during contract changes when versioning, error response shapes, and representation consistency are not properly maintained. Reviewing endpoint semantics and validation rules catches these contract flaws before release.