api-design-principles

Official

Build better APIs: REST & GraphQL.

Author3commas-io
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill helps developers design, review, and standardize intuitive, scalable, and maintainable REST and GraphQL APIs, reducing common pitfalls and improving developer experience.

Core Features & Use Cases

  • RESTful Principles: Covers resource-oriented design, HTTP method semantics, pagination, filtering, and error handling.
  • GraphQL Principles: Explains schema design, resolver patterns, and N+1 problem prevention with DataLoaders.
  • Best Practices & Pitfalls: Offers guidance on versioning, statelessness, rate limiting, and common mistakes.
  • Use Case: When starting a new microservice with a public API, use this Skill to ensure the design adheres to best practices for both REST and GraphQL, making it easier for consumers to understand and integrate with.

Quick Start

Review the core concepts for designing RESTful APIs.

Dependency Matrix

Required Modules

None required

Components

referencesassets

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: api-design-principles
Download link: https://github.com/3commas-io/commas-claude/archive/main.zip#api-design-principles

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.