skills.rest
ScientiaCapital
ScientiaCapitalCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-design

Standardizes REST/GraphQL API design with OpenAPI-ready patterns for resource naming, methods, errors, pagination, and versioning.

28|3|Updated Dec 10, 2025
Search Tags:#design#versioning#api#rest#graphql#error-handling#pagination
One-click install
npx skills add https://github.com/ScientiaCapital/skills --skill api-design-scientiacapital
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/ScientiaCapital/skills/tree/main/active/api-design-skill
Command: npx skills add https://github.com/ScientiaCapital/skills --skill api-design-scientiacapital

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

API design challenges across teams cause inconsistent REST/GraphQL endpoints, scattered error handling, and fragmented documentation.

Core Features & Use Cases

  • Standardized resource naming, HTTP methods, and error schemas for predictable APIs.
  • Pagination and versioning strategies to evolve APIs safely.
  • Use cases include designing new public APIs, refactoring legacy endpoints, and generating OpenAPI specs.

Quick Start

Draft a REST/GraphQL API design that enforces naming, error schema, and pagination for your service.

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 resource naming and error handling?▼

To design a REST API with consistent resource naming and error handling, apply standardized schemas for predictable endpoints. This standardizes HTTP methods, error formats, and pagination to reduce ambiguity and maintenance costs across teams.

What is the best way to version an API to evolve endpoints safely?▼

The best way to version an API and evolve endpoints safely is to implement structured pagination and versioning strategies. These patterns provide guardrails for updating existing services without breaking current API contracts.

How does GraphQL compare to REST for standardizing API contracts across teams?▼

GraphQL and REST both require standardized naming and error schemas to reduce fragmented documentation. Applying consistent design patterns to either format minimizes ambiguity and ensures predictable API contracts across distributed teams.

Can I generate OpenAPI specs from my existing API design?▼

Yes, you can generate OpenAPI specs by drafting a design that enforces naming, error schemas, and pagination. The resulting OpenAPI-ready patterns provide robust guardrails for documenting and refactoring legacy endpoints.

When do I need standardized pagination strategies for my API?▼

You need standardized pagination strategies when evolving existing endpoints or designing new public APIs. Implementing structured pagination ensures your service handles large datasets predictably and maintains safe API versioning.

Related Skills

Explore More Software Engineering Skills→
rsmdtrsmdt
381

api-design-patterns

Apply standardized REST and GraphQL design patterns to API contracts and versioning.

Community
Advanced
HouseGarofaloHouseGarofalo
3

openapi-swagger

Design, document, and generate APIs from OpenAPI and Swagger specifications.

Official
Advanced
AcczdyAcczdy
2

implementing-api-schema-validation-security

Enforce OpenAPI v3.x request and response schema validation against JSON Schema contracts.

Community
Advanced
Dokkabei97Dokkabei97
2

api-first-design

Design API contracts with OpenAPI and GraphQL schemas.

Community
Intermediate