skills.rest
nashirabbash
nashirabbashCOMMUNITY
Explore all skills by this author →
GitHub

api-design-principles

Apply REST and GraphQL design principles to API specifications and standards.

Updated Mar 30, 2026
Search Tags:#design#versioning#api#rest#graphql#best-practices
One-click install
npx skills add https://github.com/nashirabbash/autorepychatbot --skill api-design-principles-nashirabbash
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/nashirabbash/autorepychatbot/tree/main/.agents/skills/api-design-principles
Command: npx skills add https://github.com/nashirabbash/autorepychatbot --skill api-design-principles-nashirabbash

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

Designing robust APIs across REST and GraphQL can be inconsistent without canonical guidelines, leading to fragmentation and maintenance headaches.

Core Features & Use Cases

  • RESTful design principles: resource-oriented endpoints, proper HTTP method semantics, clear versioning, and consistent naming.
  • GraphQL design principles: schema-first development, strongly typed schemas, and strategies to avoid N+1 queries (e.g., DataLoaders).
  • Use Case: teams needing a governance template to standardize API design, review specifications, and document APIs.

Quick Start

Provide a concise REST/GraphQL API design guide for a new project.

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 and GraphQL API design?▼

Consistent API design requires resource-oriented REST endpoints, schema-first GraphQL types, proper HTTP semantics, clear versioning, and standardized error handling to ensure interfaces remain intuitive and maintainable.

How do I standardize API design for an engineering team?▼

Standardize API design by applying canonical governance templates that define REST and GraphQL specifications, review processes, and comprehensive documentation patterns to prevent architectural fragmentation.

How do I avoid N+1 queries in GraphQL schema design?▼

To avoid N+1 queries in GraphQL schema design, apply schema-first development principles and implement strategies like DataLoaders to batch and cache data fetching efficiently within your strongly typed schemas.

What is the best way to version a REST API?▼

The best way to version a REST API is by establishing clear versioning guidelines within resource-first design standards, ensuring consistent naming and proper HTTP method semantics across all resource-oriented endpoints.

Does this API design governance template work for both REST and GraphQL?▼

Yes, this API design governance template works for both REST and GraphQL by providing canonical guidelines that enforce resource-first principles for REST and schema-first development for GraphQL simultaneously.

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
lamb92009lamb92009

api-designer

Design REST and GraphQL APIs and generate OpenAPI 3.1 specifications.

Community
Advanced
ananddtyagiananddtyagi
687

API Contract Sync Manager

Validate API contracts against backend implementations and generate TypeScript clients.

Community
Advanced
inocan-groupinocan-group
18

development

Enforce design-first development with type-driven contracts and automated checks.

Official
Basic