skills.rest
act70255
act70255COMMUNITY
Explore all skills by this author →
GitHub

api-design-principles

Provide design principles and patterns for RESTful and GraphQL APIs.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill addresses the challenge of designing APIs that are intuitive, scalable, and maintainable, helping developers create APIs that delight users and stand the test of time.

Core Features & Use Cases

  • REST & GraphQL Design: Provides principles and patterns for designing RESTful and GraphQL APIs.
  • API Style and Model: Assists in choosing the right API style and resource models.
  • Error Handling & Pagination: Offers guidelines for error handling and pagination strategies.
  • Use Case: For a developer looking to design a new API, this Skill offers a comprehensive guide to ensure the API meets best practices and is developer-friendly.

Quick Start

Use the api-design-principles skill to design a new REST API by following the outlined steps in the resources/implementation-playbook.md.

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 RESTful API resource modeling and HTTP methods?▼

RESTful API design best practices focus on resource-oriented architecture, utilizing appropriate HTTP methods, and structuring endpoints intuitively. This Skill provides guidelines for resource modeling and schema design to ensure your API is scalable and maintainable.

How do I choose between REST and GraphQL for my new API schema?▼

Choosing between REST and GraphQL depends on your data fetching requirements and architectural style. This Skill assists in selecting the right API style and resource models, offering design principles and patterns for both RESTful and GraphQL APIs.

How do I design error handling and pagination strategies for scalable APIs?▼

Designing error handling and pagination strategies requires following established API design principles. This Skill offers specific guidelines for implementing these patterns, ensuring your API remains intuitive and developer-friendly as it scales.

What versioning strategies should I use for maintainable API design?▼

Maintainable API design requires effective versioning strategies to manage changes without breaking existing clients. This Skill provides principles for structuring query structures and applying versioning strategies within both REST and GraphQL architectures.

Do I need prior knowledge of API architecture to use these design principles?▼

Yes, utilizing these API design principles requires existing knowledge of REST and GraphQL fundamentals. The Skill is built for developers seeking advanced patterns and best practices to ensure their API architecture meets professional standards.

Related Skills

Explore More Software Engineering Skills→
FlorianRiquelmeFlorianRiquelme

Backend API

Design RESTful API endpoints with versioning, rate limiting, and pagination.

Community
Basic
thesaifalitaithesaifalitai
8

api-designer

Design REST and GraphQL API architectures and generate OpenAPI 3.1 specifications.

Community
Advanced
weirdgmeweirdgme
4

api-engineering

Automate API design and governance with REST, GraphQL, and gRPC best practices.

Community
Advanced
guilhermemarketingguilhermemarketing
59

nx-generate

Generate boilerplate code using Nx workspace generators.

Community
Advanced