skills.rest
KaiBoo404
KaiBoo404COMMUNITY
Explore all skills by this author →
GitHub

api-design-principles

Enforce REST and GraphQL API design standards for resources, versioning, and pagination.

Updated Aug 27, 2026
Search Tags:#design#versioning#documentation#rest#graphql#pagination#api-design
One-click install
npx skills add https://github.com/KaiBoo404/agent-skills-with-project-template --skill api-design-principles-kaiboo404
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/KaiBoo404/agent-skills-with-project-template/tree/main/.agents/skills/api-design-principles
Command: npx skills add https://github.com/KaiBoo404/agent-skills-with-project-template --skill api-design-principles-kaiboo404

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

Design and enforce API design standards for REST and GraphQL across teams.

Core Features & Use Cases

  • Establish consistent resource modeling, HTTP methods, and status semantics for REST APIs.
  • Define GraphQL schema design patterns, pagination, and error handling to improve developer experience.
  • Provide versioning, deprecation, and documentation guidelines to accelerate onboarding and maintenance.

Quick Start

Apply these principles to your API spec to ensure a clean, scalable design.

Frequently Asked Questions about api-design-principles

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

FAQPage Schema
What are the key API design principles for REST and GraphQL?▼

Key API design principles for REST and GraphQL involve codifying consistent resource modeling, HTTP status semantics, schema evolution, error handling, and pagination patterns to standardize APIs across teams.

How do I design consistent versioning and pagination for GraphQL and REST APIs?▼

Design consistent versioning and pagination by applying codified patterns for schema evolution and cursor-based pagination during your API review and new API design phases to ensure scalable resources.

What is the best way to enforce API design standards across engineering teams?▼

The best way to enforce API design standards is to codify REST and GraphQL requirements into principles that tooling and codegen can apply during new API design, paradigm migration, and API reviews.

When do I need API design guidelines for paradigm migration?▼

You need API design guidelines for paradigm migration when transitioning between REST and GraphQL to ensure consistent resource modeling, proper error handling, and structured schema evolution requirements.

Does this API design approach work for both new API design and legacy review?▼

Yes, this API design approach works for both new API design and legacy review by providing versioning, deprecation, and documentation guidelines to accelerate onboarding and maintain consistent resources.

Why standardize error handling and schema evolution in API design?▼

Standardizing error handling and schema evolution in API design improves developer experience and accelerates maintenance by defining strict GraphQL schema patterns and REST semantics for tooling and codegen.

Related Skills

Explore More Software Engineering Skills→
sigmadigitalzasigmadigitalza
1

api-design-review

Review REST and GraphQL API designs for quality and compatibility issues.

Official
Advanced
nashirabbashnashirabbash

api-documentation

Generate OpenAPI specs and interactive documentation for REST and GraphQL APIs.

Community
Intermediate
vladm3105vladm3105
16

contract-tester

Validate API contracts and detect breaking changes across OpenAPI/AsyncAPI specifications.

Community
Advanced
knckknckknckknck

go-style-guide

Standardize Go code quality and style across projects.

Community
Intermediate