skills.rest
as4584
as4584COMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-design-principles

Guide REST and GraphQL API design with schema, versioning, and error handling principles.

2|Updated Jan 18, 2026
Search Tags:#best practices#api design#rest#developer experience#graphql#software architecture
One-click install
npx skills add https://github.com/as4584/antigravity-skills --skill api-design-principles-as4584
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/as4584/antigravity-skills/tree/main/agents-wshobson/plugins/backend-development/skills/api-design-principles
Command: npx skills add https://github.com/as4584/antigravity-skills --skill api-design-principles-as4584

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

What problem does it solve?

This Skill helps developers design and build intuitive, scalable, and maintainable REST and GraphQL APIs by providing best practices, patterns, and guidance.

Core Features & Use Cases

  • RESTful Design: Learn resource-oriented architecture, HTTP method semantics, and common patterns like pagination and error handling.
  • GraphQL Design: Understand schema design, resolver patterns, and N+1 problem prevention with DataLoaders.
  • Use Case: When designing a new microservice API, consult this Skill to ensure adherence to industry best practices for both REST and GraphQL, leading to a more developer-friendly and robust API.

Quick Start

Use the api-design-principles skill to review best practices for designing RESTful APIs.

Frequently Asked Questions about api-design-principles

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

FAQPage Schema
What are the best practices for REST API design and resource-oriented architecture?▼

Best practices for REST API design involve using resource-oriented architecture, proper HTTP method semantics, and standard patterns for pagination and error handling to ensure robust and maintainable APIs.

How do I design a GraphQL schema and prevent the N+1 problem?▼

To design a GraphQL schema and prevent the N+1 problem, implement proper resolver patterns and utilize DataLoaders for efficient batching and caching of data fetches.

What is the best way to handle API versioning and error handling for microservices?▼

The best way to handle API versioning and error handling is to follow established principles for both REST and GraphQL paradigms, addressing common pitfalls to build a developer-friendly microservice API.

How do I optimize API performance and improve developer experience for REST and GraphQL?▼

Optimize API performance and developer experience by applying comprehensive design principles, schema patterns, and performance optimization techniques tailored for both REST and GraphQL architectures.

When should I choose REST vs GraphQL for my software architecture?▼

Choosing REST vs GraphQL depends on your software architecture needs; this guidance covers principles, patterns, and practical examples for both paradigms to help you design intuitive and scalable APIs.

Related Skills

Explore More Software Engineering Skills→
The-AIOSThe-AIOS
15

api-design-principles

Explain REST and GraphQL API design principles, patterns, and best practices.

Official
Advanced
hffmnnjhffmnnj
39

api-docs

Generate API reference documentation from OpenAPI specs and GraphQL schemas.

Community
Advanced
twofoldtech-dakotatwofoldtech-dakota
2

fullstack-modern

Coordinate React or Vue frontends with GraphQL and REST APIs in Next.js-style apps.

Community
Advanced
erichowenserichowens
181

api-architect

Design and validate REST, GraphQL, and gRPC API contracts and architectures.

Community
Advanced