skills.rest
mokbhai
mokbhaiCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-design-principles

Provide REST and GraphQL design principles for API conception, review, and standardization.

1|Updated Jan 15, 2026
Search Tags:#versioning#documentation#GraphQL#REST#best-practices#api-design
One-click install
npx skills add https://github.com/mokbhai/claude --skill api-design-principles-mokbhai
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/mokbhai/claude/tree/main/skills/api-design-principles
Command: npx skills add https://github.com/mokbhai/claude --skill api-design-principles-mokbhai

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This skill provides structured principles to design consistent, scalable, and developer-friendly REST and GraphQL APIs, addressing confusion, inconsistency, and maintenance overhead.

Core Features & Use Cases

  • Principled REST design: Resource-oriented endpoints, proper HTTP methods, and stable URL schemas.
  • GraphQL best practices: Typed schemas, clear query/mutation structure, and real-time subscriptions.
  • Versioning and error handling: Clear versioning strategies and standardized error payloads.
  • Use cases: When starting a new API project, performing API reviews, or standardizing API design across teams.

Quick Start

Draft a RESTful API plan for a new service by listing resources, endpoints, and a GraphQL schema sketch, then summarize the core design guidelines.

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

REST API design and GraphQL schema discipline best practices involve structuring resource-oriented endpoints, applying proper HTTP semantics, defining typed schemas, and organizing clear query and mutation structures for scalable, developer-friendly interfaces.

How do I standardize API design across teams and review existing endpoints?▼

To standardize API design and review endpoints, apply structured principles enforcing REST resources, HTTP semantics, GraphQL schema discipline, versioning strategies, and error handling patterns to resolve inconsistencies across projects.

What should I include when drafting a plan for a new RESTful API service?▼

Drafting a RESTful API plan requires listing resources, endpoints, and a GraphQL schema sketch, then summarizing core design guidelines to ensure consistent resource orientation and stable URL schemas from conception.

Which API versioning strategies and error handling patterns should I use?▼

API versioning strategies and error handling patterns should use clear versioning conventions and standardized error payloads to maintain stable URL schemas and reduce maintenance overhead during API migration.

When should I migrate between REST and GraphQL for my API project?▼

Migrate between REST and GraphQL during standardization or when addressing maintenance overhead, using structured principles to transition resource-oriented endpoints into typed schemas with clear query and mutation structures.

Related Skills

Explore More Software Engineering Skills→
dhruvinrsonidhruvinrsoni

api-contract-design

Design REST or gRPC API contracts using OpenAPI or Protobuf specifications.

Community
Advanced
thesaifalitaithesaifalitai
8

api-designer

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

Community
Advanced
boengaiboengai
1

HiveBoard GraphQL API

Query and mutate HiveBoard kanban data via GraphQL HTTP and SSE subscriptions.

Community
Advanced
Sumeet138Sumeet138
1

api-design-principles

Design REST and GraphQL APIs with resource-oriented patterns and versioning.

Community
Advanced