
from atlas-agents433
Guidelines and verification checklist for designing clear, versioned, and machine-friendly REST and GraphQL APIs, including schemas, error envelopes, and pagina
This skill provides a practical, opinionated process for designing REST and GraphQL APIs that are predictable for both developers and agents. It walks through identifying domain objects, structuring resource hierarchies, defining request/response schemas with examples and validation rules, establishing a consistent error envelope, and deciding on pagination and versioning strategies. The goal is clear contracts that are easy to consume, test, and evolve.
Use this skill when you need to design a new API surface, review or refactor existing endpoints, write request/response schemas for documentation or codegen, or establish team-wide conventions (error formats, pagination, versioning). It's appropriate during API design reviews, API-first development, and when preparing public-facing developer docs.
This skill is tool-agnostic but is especially useful for coding assistants and agents that generate or review API definitions (Copilot-like code assistants, Codex, Claude Code, Gemini CLI). It helps agents produce consistent API schemas and documentation.
This skill has not been reviewed by our automated audit pipeline yet.