api-design-principles

Design REST and GraphQL APIs with resource-oriented patterns and versioning.

1|Updated Apr 14, 2026
One-click install
npx skills add https://github.com/Sumeet138/qwen-code-agents --skill api-design-principles-sumeet138
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/Sumeet138/qwen-code-agents/tree/main/plugins/backend-development/skills/api-design-principles
Command: npx skills add https://github.com/Sumeet138/qwen-code-agents --skill api-design-principles-sumeet138

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

Design robust REST and GraphQL APIs that are scalable and developer-friendly.

Core Features & Use Cases

  • REST API design patterns including resource-oriented endpoints, proper HTTP methods, and versioning strategies.
  • GraphQL schema design, pagination patterns, and efficient data fetching best practices.
  • Use Case: Designing new APIs, reviewing specifications, or establishing team-wide API design standards for REST and GraphQL projects.

Quick Start

Provide a REST/GraphQL design brief following established API design principles.

Frequently Asked Questions about api-design-principles

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

FAQPage Schema
How do I design robust REST and GraphQL APIs that scale?

To design robust REST and GraphQL APIs that scale, enforce resource-oriented design, proper HTTP methods, versioning strategies, and efficient data fetching patterns. This ensures your endpoints remain developer-friendly and maintainable as your system grows.

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

Handling pagination in GraphQL and REST APIs requires implementing standardized pagination patterns for efficient data fetching. This prevents payload bloat and ensures clients can navigate large datasets predictably without overwhelming the server.

How do I establish team-wide API design standards for REST and GraphQL?

Establishing team-wide API design standards for REST and GraphQL involves enforcing consistent schema modeling, error handling, versioning, and documentation best practices. This creates a unified developer experience across all internal and external endpoints.

Does this approach to API design work for both new architectures and reviewing specifications?

Yes, this API design approach works for both architecting new APIs and reviewing existing specifications. It applies resource-oriented design principles and schema modeling best practices to validate and standardize your REST and GraphQL projects.

How do I start designing an API using these design principles?

To start designing an API using these principles, provide a REST or GraphQL design brief outlining your requirements. This brief is then evaluated against established resource-oriented design, versioning, and documentation best practices to generate a robust specification.