api-design

Design REST and GraphQL APIs with OpenAPI 3.x specifications.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/SalesTeamToolbox/frood --skill api-design-salesteamtoolbox
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/SalesTeamToolbox/frood/tree/main/skills/builtins/api-design
Command: npx skills add https://github.com/SalesTeamToolbox/frood --skill api-design-salesteamtoolbox

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It helps you avoid inconsistent endpoints, ambiguous schemas, and brittle error handling by providing a practical, standards-based approach to API design.

Core Features & Use Cases

  • REST endpoint design: Apply resource naming, nesting rules, and HTTP method semantics to keep APIs predictable.
  • API behavior contracts: Define pagination, filtering, sorting, and versioning strategies that scale as usage grows.
  • Production-ready reliability: Standardize authentication, status codes, and error response structure (including request traceability).
  • Documentation requirements: Produce an OpenAPI 3.x spec and validate it in CI for consistent, discoverable interfaces.
  • Use Case: Design a public API for an e-commerce service where clients need stable versioning, cursor pagination, and clear error codes for storefront and admin apps.

Quick Start

Ask: Design a REST v1 API for managing orders with cursor pagination, filtering by status and date, JWT auth, and a consistent error schema with request_id.

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 error handling and pagination?

Design clean REST APIs by standardizing resource naming, HTTP method semantics, and structured machine-readable error responses. Implement cursor pagination, filtering, and sorting strategies to ensure your API remains predictable and scales reliably as usage grows.

What is the best way to structure API versioning and authentication for a public service?

Structure API versioning by defining clear behavior contracts for stable client compatibility. Standardize JWT authentication, map correct HTTP status codes, and maintain consistent naming conventions to secure public or internal service contracts.

How do I generate an OpenAPI 3.x specification for CI validation?

Generate an OpenAPI 3.x specification by defining your REST endpoints, schemas, and error responses. Produce this machine-readable documentation to enable consistent interface discovery and validate it within your CI pipeline for reliable client compatibility.

Does this approach work for both REST and GraphQL API design?

Yes, this approach works for both REST and GraphQL API design. It standardizes endpoint schemas, versioning, authentication, and rate limiting across both paradigms, ensuring clean, reliable interfaces for CRUD resources and internal service contracts.

Why do my API endpoints return ambiguous schemas and brittle error codes?

Ambiguous schemas and brittle error codes occur when API design lacks standards-based endpoint naming and structured error responses. Fix this by applying consistent HTTP method mapping, machine-readable error structures with request_id, and OpenAPI 3.x documentation.