api-design

Define and validate REST and GraphQL API contracts with schemas and versioning.

19|3|Updated Feb 28, 2026
One-click install
npx skills add https://github.com/qa-aman/claude-skills --skill api-design-qa-aman
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/qa-aman/claude-skills/tree/main/skills/by-role/engineer/api-design
Command: npx skills add https://github.com/qa-aman/claude-skills --skill api-design-qa-aman

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Define and validate clean API contracts to reduce integration failures.

Core Features & Use Cases

  • Design REST endpoints with nouns and standard HTTP verbs
  • Create GraphQL schemas and resolver contracts
  • Establish consistent error handling, versioning, and docs

Quick Start

Provide an API design outline for a new user service including REST endpoints and a basic GraphQL schema.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design consistent REST API endpoints and reduce integration failures?

To design consistent REST API endpoints and reduce integration failures, define clean API contracts that specify request and response schemas, use nouns for resource paths, and apply standard HTTP verbs for predictable interactions.

What is the best way to structure GraphQL schemas and resolver contracts?

The best way to structure GraphQL schemas and resolver contracts is to define clean API contracts that establish consistent naming conventions, error shapes, and documentation guidelines across product teams and service-oriented architectures.

How do I establish consistent error handling and versioning for developer-facing APIs?

Establish consistent error handling and versioning for developer-facing APIs by defining clean API contracts that standardize error shapes and versioning guidelines, ensuring predictable behavior across all service-oriented architectures and integrations.

Can I use this approach to define API documentation guidelines for my product team?

Yes, you can use this approach to define API documentation guidelines for your product team by applying clean API contract principles that specify request and response schemas, naming conventions, and error shapes for both REST and GraphQL interfaces.

What are the limitations of designing API contracts without standard naming conventions?

Designing API contracts without standard naming conventions leads to increased integration failures, inconsistent developer-facing interfaces, and misaligned request and response schemas across REST and GraphQL services.

Does the api-design approach work for both REST and GraphQL API design?

Yes, the api-design approach works for both REST and GraphQL API design by specifying request and response schemas, error shapes, versioning, and documentation guidelines to define clean, battle-tested API contracts across product teams.