skills.rest
Wania-Kazmi
Wania-KazmiCOMMUNITY
Explore all skills by this author →
GitHub

api-patterns

Standardize REST and GraphQL API design with consistent routes, authentication, and error handling.

5|1|Updated Jan 20, 2026
Search Tags:#documentation#openapi#GraphQL#backend#REST#design-patterns#API-security
One-click install
npx skills add https://github.com/Wania-Kazmi/claude-code-autonomous-agent-workflow --skill api-patterns-wania-kazmi
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-patterns
Source: https://github.com/Wania-Kazmi/claude-code-autonomous-agent-workflow/tree/main/.claude/skills/api-patterns
Command: npx skills add https://github.com/Wania-Kazmi/claude-code-autonomous-agent-workflow --skill api-patterns-wania-kazmi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides standardized REST API and GraphQL design patterns, enabling teams to build robust, secure, and scalable interfaces while ensuring consistent error handling and documentation.

Core Features & Use Cases

  • Resource-oriented design: Guidance on resource-based URLs and appropriate HTTP methods.
  • Error handling and responses: Standardized error schemas and status codes for predictable client behavior.
  • GraphQL & OpenAPI patterns: Examples for schema design, resolvers, and automatic API documentation.
  • Use Case: When designing a new API, apply these patterns to ensure clean endpoints and reliable error handling across services.

Quick Start

Run a design review by applying the included patterns to your API blueprint and update your OpenAPI/GraphQL schemas accordingly.

Frequently Asked Questions about api-patterns

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

FAQPage Schema
What are the best design patterns for REST API resource-based URLs and HTTP methods?▼

REST API design patterns standardize resource-based URLs and proper HTTP methods to improve maintainability. They enforce consistent routes across backend services, ensuring predictable client behavior and scalable interfaces for microservices.

How do I structure error handling and status codes for a backend API?▼

Standardized error handling patterns provide structured error responses and proper HTTP status codes for backend APIs. This ensures predictable client behavior by applying consistent error schemas across microservices and gateway APIs.

How do I design a GraphQL schema with resolvers for a new microservice?▼

GraphQL schema patterns guide resolver design and schema structure for new microservices. They provide standardized examples for building robust, secure, and scalable interfaces while ensuring consistent documentation across backend services.

Does this approach apply to both REST and GraphQL API authentication schemes?▼

Yes, these API security patterns apply to both REST and GraphQL authentication schemes. They standardize authentication for backend services and gateway APIs needing consistent routes, ensuring robust and secure interfaces across different architectures.

Can I use these API patterns to generate OpenAPI documentation for my existing endpoints?▼

Yes, OpenAPI patterns guide automatic API documentation generation for existing endpoints. You can apply these patterns to your API blueprint and update your OpenAPI schemas accordingly to ensure clean endpoints and reliable error handling.

When should I not use standardized API design patterns for my gateway APIs?▼

Standardized API design patterns may not suit gateway APIs requiring highly custom routes or non-standard HTTP methods. If your backend services do not need consistent resource-based URLs or structured error responses, these patterns add unnecessary constraints.

Related Skills

Explore More Software Engineering Skills→
ciandt-fulviociandt-fulvio

impl-service

Centralize business rules and orchestration in the service layer.

Community
Advanced
hffmnnjhffmnnj
39

api-docs

Generate API reference documentation from OpenAPI specs and GraphQL schemas.

Community
Advanced
geoffjaygeoffjay
8

sinatra-patterns

Organize Sinatra routing, middleware, error handling, and template integration patterns.

Community
Intermediate
PriyanshKuniyalPriyanshKuniyal

api-design-principles

Provide guidelines for designing REST and GraphQL APIs.

Community
Advanced