api-design-principles

Creates REST and GraphQL API design proposals with schema-first patterns, versioning, error handling, and documentation guidelines.

Updated Feb 24, 2026
One-click install
npx skills add https://github.com/chicanoandres702/SentientAIBrowser --skill api-design-principles-chicanoandres702
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/chicanoandres702/SentientAIBrowser/tree/main/.agent/skills/api-design-principles
Command: npx skills add https://github.com/chicanoandres702/SentientAIBrowser --skill api-design-principles-chicanoandres702

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

REST and GraphQL API design can be inconsistent across teams, leading to confusing integrations and brittle systems.

Core Features & Use Cases

  • Schema-first patterns for REST and GraphQL
  • Versioning strategies, error handling, and pagination guidelines
  • Guidance for API reviews, documentation, and governance
  • Real-world scenarios: designing a new service, reviewing an existing API, standardizing API practices

Quick Start

Provide a complete API design proposal that follows REST and GraphQL principles 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
How do I design consistent REST and GraphQL APIs across multiple teams?

To design consistent REST and GraphQL APIs, apply schema-first patterns, enforce input validation, standardize error handling, and establish clear documentation guidelines for cross-team alignment.

What is the best way to version REST and GraphQL APIs?

The best way to version REST and GraphQL APIs involves adopting standardized versioning strategies during the design phase, ensuring backward compatibility while allowing iterative schema evolution without breaking integrations.

How do I handle pagination and errors in a scalable API design?

Handle pagination and errors in scalable API design by implementing consistent pagination guidelines and standardized error handling protocols across all endpoints to maintain system stability.

Can I use schema-first design for both REST and GraphQL services?

Yes, you can use schema-first design for both REST and GraphQL services. It requires defining data contracts upfront, which streamlines input validation, API reviews, and governance.

When should I standardize API practices during a project lifecycle?

Standardize API practices during the project lifecycle when designing a new service, reviewing an existing API, or establishing governance to prevent confusing integrations and brittle systems.

Why do my API integrations become brittle and inconsistent?

API integrations become brittle and inconsistent due to a lack of standardized design principles. Applying schema-first thinking, strict versioning, and clear documentation guidelines resolves these integration issues.