skills.rest
Elric412
Elric412COMMUNITY
Explore all skills by this author →
GitHub

designing-apis

Design REST and GraphQL APIs with endpoints, error handling, versioning, and documentation.

Updated Aug 23, 2026
Search Tags:#design#documentation#openapi#rest#graphql#patterns#apis
One-click install
npx skills add https://github.com/Elric412/Leica-cam --skill designing-apis-elric412
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: designing-apis
Source: https://github.com/Elric412/Leica-cam/tree/main/.agents/skills/designing-apis
Command: npx skills add https://github.com/Elric412/Leica-cam --skill designing-apis-elric412

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Designs REST and GraphQL APIs including endpoints, error handling, versioning, and documentation. Use when creating new APIs, designing endpoints, reviewing API contracts, or when asked about REST, GraphQL, or API patterns.

Core Features & Use Cases

  • Builds clear API contracts with defined endpoints, error handling, and versioning strategies.
  • Provides OpenAPI templates and best practices to document REST and GraphQL APIs.
  • Use Case: When starting a new service, generate an OpenAPI specification and a design checklist.

Quick Start

Ask me to design a REST or GraphQL API for a given domain and generate an OpenAPI specification.

Frequently Asked Questions about designing-apis

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

FAQPage Schema
How do I design a REST API with proper error handling and versioning?▼

Designing a REST API with error handling and versioning involves defining clear API contracts that establish endpoint structures, error formats, and versioning strategies. This provides a blueprint for robust and consistent service communication.

What is the best way to generate OpenAPI specifications for a new service?▼

The best way to generate OpenAPI specifications is to apply API design patterns and reference templates during the initial service design phase. This ensures your REST endpoints are documented consistently from the start.

When should I choose GraphQL over REST for my API endpoints?▼

Choose GraphQL over REST when your API endpoints require flexible data retrieval patterns and complex nested queries. Both approaches are supported, allowing you to apply appropriate patterns based on your specific data fetching needs.

How do I review an existing API contract for consistency?▼

Reviewing an API contract for consistency involves checking endpoint definitions, error handling protocols, and versioning strategies against established API patterns and best practices to identify gaps or structural issues.

Does this approach provide templates for documenting both REST and GraphQL APIs?▼

Yes, the approach provides OpenAPI templates and best practices specifically designed to document both REST and GraphQL APIs, ensuring that your generated specifications and design checklists maintain consistency.

Related Skills

Explore More Software Engineering Skills→
Serg28Serg28

api-designer

Create OpenAPI 3.1 YAML specifications with endpoints, schemas, and security.

Community
Intermediate
foutoucourfoutoucour

api-documenter

Scan code for API route handlers and generate OpenAPI 3.0 specs and Markdown docs.

Community
Intermediate
dinoudondinoudon

api-documentation

Generates API references and SDK scaffolds from OpenAPI specifications.

Community
Advanced
HeldinhowHeldinhow
4

grpc-microservices

Enable gRPC communication between microservices using Protocol Buffers.

Community
Advanced