api-design

Enforce REST conventions, response shapes, and 422 validation errors for backend endpoints.

17|5|Updated Feb 6, 2026
One-click install
npx skills add https://github.com/MonumentalSystems/Atlas-Agent-Teams --skill api-design-monumentalsystems
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/MonumentalSystems/Atlas-Agent-Teams/tree/main/teams/fullstack-dev/skills/api-design
Command: npx skills add https://github.com/MonumentalSystems/Atlas-Agent-Teams --skill api-design-monumentalsystems

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It helps prevent inconsistent, fragile API behavior by enforcing clear REST conventions, predictable response shapes, and safe input validation.

Core Features & Use Cases

  • REST Conventions: Ensures consistent resource naming, correct HTTP method usage, sub-resource nesting, and filtering via query params (e.g., /posts?status=published&author=123).
  • Response & Error Contract: Standardizes successful responses and structured error payloads with status codes like 422 for validation errors.
  • Validation, Auth, and Versioning: Applies boundary validation, auth middleware at the router level, and a clear versioning strategy using /api/v1/... when needed.

Quick Start

Ask your team to apply the API design guidelines for your new endpoint and generate the endpoint path, method, response schema, and 422 validation error details.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design a REST API with consistent response schemas and error formats?

To design a REST API with consistent response schemas, establish standardized JSON response shapes and structured error payloads. This ensures predictable API behavior by enforcing clear REST conventions and safe input validation across all endpoints.

What HTTP status codes should I use for API validation errors?

Use HTTP status code 422 for API validation errors to provide field-level details. This structured error payload approach standardizes boundary validation, ensuring clients receive specific feedback on invalid input fields within the JSON response format.

How do I structure nested sub-resources and filtering in a REST API?

Structure nested sub-resources and filtering in a REST API by applying consistent resource naming and using query parameters. For example, filter CRUD resources via endpoints like /posts?status=published&author=123 to maintain predictable REST API behavior.

What's the best way to version a REST API URL?

The best way to version a REST API URL is using a defined versioning strategy like /api/v1/... when needed. This approach maintains backward compatibility while enforcing clear REST conventions across your backend endpoint design.

How does authentication and authorization enforcement work in REST API design?

Authentication and authorization enforcement in REST API design works by applying auth middleware at the router level. This ensures boundary validation and access control are consistently enforced before reaching CRUD resource endpoints.

Can I use this REST API design approach for backend CRUD endpoints?

Yes, you can use this REST API design approach for backend CRUD endpoints. It applies to CRUD resources, nested sub-resources, filtering, and authentication enforcement, ensuring correct HTTP status codes and JSON response formats.