skills.rest
duanbiao2000
duanbiao2000COMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-design-principles

Implement REST and GraphQL API design patterns, versioning, and error handling.

3|1|Updated Feb 3, 2026
Search Tags:#versioning#documentation#rest#graphql#design-principles#api-design#api-review
One-click install
npx skills add https://github.com/duanbiao2000/obsidianDoc26 --skill api-design-principles-duanbiao2000
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/duanbiao2000/obsidianDoc26/tree/main/agents-main/plugins/backend-development/skills/api-design-principles
Command: npx skills add https://github.com/duanbiao2000/obsidianDoc26 --skill api-design-principles-duanbiao2000

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This principle-focused skill helps teams design intuitive, scalable REST and GraphQL APIs that reduce confusion and increase developer satisfaction by following established guidelines.

Core Features & Use Cases

  • Guides resource-oriented design, versioning strategies, error handling, pagination, and documentation standards for REST and GraphQL.
  • Useful for designing new APIs, reviewing API specifications, and standardizing API design across teams for consistent developer experiences.
  • Real-world use: teams align on endpoint naming, version strategies, and error payload structures during API rollout.

Quick Start

Provide a practical API design review for a new REST or GraphQL service, applying RESTful and GraphQL design principles.

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 REST and GraphQL API design principles for scalable interfaces?▼

To design a REST API, apply resource-oriented design, choose a versioning strategy, define error payload structures, and establish pagination and documentation standards to ensure a consistent developer experience.

How do I review an API specification for REST and GraphQL design gaps?▼

Reviewing API specifications involves checking endpoint naming, version strategies, and error payloads against established REST and GraphQL design principles to resolve usage-specific boundaries and standardize interfaces.

What is the best way to implement versioning and error handling in API design?▼

The best way to implement versioning and error handling is applying robust REST and GraphQL patterns, aligning on version strategies, and standardizing error payload structures during API rollout for real-world scenarios.

When should I standardize API design across my development teams?▼

You should standardize API design across teams during new API rollouts to align on endpoint naming, versioning strategies, and error structures, ensuring consistent developer experiences and reducing integration confusion.

Does this API design approach support both REST and GraphQL boundaries?▼

Yes, this approach resolves usage-specific patterns and boundaries for both REST and GraphQL interfaces, guiding resource-oriented design, versioning, and error handling to increase developer satisfaction.

Related Skills

Explore More Software Engineering Skills→
angga30angga30

api-design-principles

Define and enforce consistent REST and GraphQL API design practices.

Community
Advanced
involvexinvolvex
1

developer-detective

Trace data flow across call graphs using AST analysis.

Community
Advanced
ntygodntygod
171

api-debugger

Automate REST and GraphQL API response testing against documentation.

Community
Intermediate
edulazaroedulazaro
12

lc:analyze-model

Analyze Laravel Eloquent models and migration files for architectural inconsistencies.

Community
Advanced