rest-api

Audit REST API design and documentation for consistent endpoints, schemas, and errors.

9|1|Updated Feb 1, 2026
One-click install
npx skills add https://github.com/calcosmic/Aether --skill rest-api-calcosmic
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rest-api
Source: https://github.com/calcosmic/Aether/tree/main/.aether/skills-codex/domain/rest-api
Command: npx skills add https://github.com/calcosmic/Aether --skill rest-api-calcosmic

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Designing consistent, scalable REST APIs and ensuring reliable consumption by clients can be error-prone without clear guidelines, leading to brittle endpoints, inconsistent status handling, and confusing docs.

Core Features & Use Cases

  • Resource design: use nouns for endpoints, versioned paths, consistent nesting and naming.
  • Status codes and error handling: use the standard mapping and consistent error response structure.
  • Request/Response format: JSON payloads with consistent field naming (camelCase or snake_case) and a unified error format.
  • Documentation and standards: maintain an OpenAPI spec and sample requests.
  • Pagination, authentication, and rate limiting: implement cursor-based pagination, bearer token authentication, and response rate limits.
  • Use Case: For a mobile app consuming a public API, apply these practices to ensure discoverability and reliability.

Quick Start

Audit your API design and documentation to apply the recommended REST practices in every endpoint.

Frequently Asked Questions about rest-api

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

FAQPage Schema
How do I design consistent REST API endpoints and schemas?

REST API design uses nouns for endpoints, versioned paths, and consistent nesting to reduce inconsistency. Apply standardized JSON request and response schemas with unified field naming like camelCase or snake_case to ensure reliable client consumption.

What HTTP status codes and error formats should my REST API use?

REST APIs should use standard HTTP status code mappings and a consistent error response structure. Maintaining a unified error format across all endpoints prevents brittle client behavior and confusing documentation.

How do I implement pagination and rate limiting in an OpenAPI project?

Implement cursor-based pagination and bearer token authentication to manage REST API resources effectively. Apply response rate limits and maintain an OpenAPI specification with sample requests to document these constraints.

Does my API need OpenAPI or Swagger detection for reliable consumption?

OpenAPI or Swagger detection is required for REST API projects to maintain accurate documentation and sample requests. This ensures endpoint discoverability and reliable integration when clients consume your public API.

What is the best way to audit existing REST API documentation for consistency?

Auditing REST API documentation involves checking endpoint naming, versioning, and error structures against recommended practices. This process streamlines API design and reduces brittleness across resources, responses, and authentication methods.