skills.rest
BigPapiCB
BigPapiCBCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Design REST and GraphQL API architectures with consistent URL conventions, status codes, and pagination.

2|Updated Feb 6, 2026
Search Tags:#design#versioning#api#rest#graphql#patterns#pagination
One-click install
npx skills add https://github.com/BigPapiCB/Universal-Claude-Skills --skill api-design-bigpapicb
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/BigPapiCB/Universal-Claude-Skills/tree/main/api-design
Command: npx skills add https://github.com/BigPapiCB/Universal-Claude-Skills --skill api-design-bigpapicb

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

REST and GraphQL API design often suffer from inconsistency in URL patterns, error formats, and versioning, leading to integration friction and brittle contracts.

Core Features & Use Cases

  • Establishes REST URL conventions (plural nouns, no verbs in URLs) and GraphQL schema guidance to ensure consistent contracts across teams.
  • Defines standard status codes, error payload formats, and pagination strategies to simplify client-server interaction and versioning.
  • Use Case: When designing a new API or reviewing an API contract, apply these patterns to align designs with organizational standards.

Quick Start

Write a REST or GraphQL API design document following REST URL conventions, status codes, pagination, and error formats.

Frequently Asked Questions about api-design

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

FAQPage Schema
What are the standard REST URL conventions for API design?▼

Standard REST API design uses plural nouns in URL paths and omits verbs to ensure consistent resource contracts. This approach aligns endpoint architectures with organizational standards and reduces client-server integration friction.

How do I structure error payloads and status codes for a REST API?▼

Structure REST API error payloads by applying standard HTTP status codes and consistent error formats. Defining these patterns simplifies client-server interaction, clarifies endpoint failures, and establishes robust API contracts for handling errors.

What is the best way to implement pagination in GraphQL and REST APIs?▼

The best way to implement API pagination is by defining consistent pagination schemas across REST and GraphQL services. Standard pagination strategies simplify client-server interaction, ensure scalable data retrieval, and maintain robust API contracts.

How do I handle API versioning and endpoint evolution across services?▼

Handle API versioning and endpoint evolution by applying consistent design patterns across REST and GraphQL services. Establishing standard versioning strategies prevents brittle contracts and ensures smooth transitions as your API architecture scales.

When do I need to review an API contract for consistency?▼

You need to review an API contract for consistency when designing a new API or evolving endpoints across services. Reviewing URL patterns, pagination schemas, and error formats ensures designs align with organizational standards and prevents integration friction.

Related Skills

Explore More Software Engineering Skills→
Fr-e-dFr-e-d
157

architecture-extract

Analyze project directory structures to generate architectural summaries.

Community
Basic
icartshicartsh
4

api-designer

Design RESTful and GraphQL APIs with OpenAPI 3.0 specifications.

Community
Advanced
heidsoftheidsoft
57

api-integration-testing

Automate API integration testing for requests, responses, and authentication.

Community
Advanced
ginkidaginkida
20

openapi-expert

Design, validate, and generate code from OpenAPI 3.x specifications.

Community
Advanced