skills.rest
peopleforrester
peopleforresterCOMMUNITY
Explore all skills by this author →
Website𝕏@peopleforresterGitHub

api-designer

API Design and Development for Beginners and Pros alike. Master the craft of building exceptional APIs with this in-depth courseUTE — from beginner-friendly foundations to advanced implementation strategies. Learn how to create your own APIs from scratchUTE-style with actionable stepsUTE-style with actionable stepsUTE-style with actionable stepsUTE-style with actionable stepsUTE-style with actiona

3|Updated Jan 29, 2026
Search Tags:#design#documentation#API#GraphQL#REST#OpenAPI
One-click install
npx skills add https://github.com/peopleforrester/claude-dotfiles --skill api-designer-peopleforrester
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/peopleforrester/claude-dotfiles/tree/main/skills/development/api-designer
Command: npx skills add https://github.com/peopleforrester/claude-dotfiles --skill api-designer-peopleforrester

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Designing and documenting APIs consistently across REST and GraphQL projects is error-prone and time-consuming. This Skill helps teams create clear API contracts, reduce misinterpretation, and accelerate integration.

Core Features & Use Cases

  • Guided API design: establishes consistent URL structures, naming conventions, and versioning plans for REST and GraphQL endpoints.
  • Documentation templates: generates ready-to-use API docs with example requests/responses and schema references.
  • Review and governance: analyzes existing APIs for consistency, promotes best practices, and helps design error handling and pagination strategies.
  • Use Case: when adding a new endpoint like GET /v1/users, the Skill outputs a complete contract including path, parameters, responses, and examples.

Quick Start

To begin, instantiate the api-designer skill in Claude Code and provide a high-level API goal. Then ask it to draft a contract for a new endpoint or review an existing API structure.

Frequently Asked Questions about api-designer

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

FAQPage Schema
How do I design consistent REST and GraphQL endpoints across multiple projects?▼

To design consistent REST and GraphQL endpoints, you need enforced naming conventions, versioning strategies, and standardized error responses. Generating complete API contracts with path parameters and sample payloads ensures consistency across multiple projects and teams.

What is the best way to document an existing API structure with sample payloads?▼

The best way to document an API structure is by generating documentation templates with example requests, responses, and schema references. Reviewing existing APIs ensures best practices for error handling and pagination strategies are applied.

Can I generate a full API contract for a new endpoint like GET /v1/users?▼

Yes, you can generate a full API contract for a new endpoint like GET /v1/users. By providing a high-level API goal, the tool outputs the complete contract including the path, parameters, responses, and examples.

Does this API design approach support both REST and GraphQL error response standards?▼

Yes, this API design approach supports both REST and GraphQL error response standards. It analyzes existing APIs for consistency and helps design standardized error handling and pagination strategies across both protocols.

How do I review an existing API for consistency and best practices?▼

To review an existing API for consistency, analyze its structures against established naming conventions and versioning plans. This governance process identifies inconsistencies and promotes best practices for error handling and pagination strategies.

Related Skills

Explore More Software Engineering Skills→
gabriellpequenogabriellpequeno
8

api-patterns

Define and enforce API design patterns across REST, GraphQL, and tRPC implementations.

Community
Intermediate
summarybotngsummarybotng
2

QE Contract Testing

Automate API contract testing with Pact, OpenAPI, and GraphQL schema validation.

Official
Advanced
thrutheskythruthesky
1

data-skill

Integrate Korea public data APIs with REST, JSON/XML, and serviceKey authentication.

Community
Advanced
icartshicartsh
4

api-designer

Design RESTful and GraphQL APIs with OpenAPI 3.0 specifications.

Community
Advanced