skills.rest
eroslifestyle
eroslifestyleCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Design REST, GraphQL, and OpenAPI specifications with versioning and testing.

1|Updated Feb 1, 2026
Search Tags:#versioning#api design#openapi#rest#graphql#api development
One-click install
npx skills add https://github.com/eroslifestyle/Claude-Orchestrator-Plugin --skill api-design-eroslifestyle
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/eroslifestyle/Claude-Orchestrator-Plugin/tree/main/github-package/skills/api-design
Command: npx skills add https://github.com/eroslifestyle/Claude-Orchestrator-Plugin --skill api-design-eroslifestyle

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires requests, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill addresses the complexities of designing and implementing modern APIs, ensuring adherence to best practices for REST, GraphQL, and OpenAPI specifications.

Core Features & Use Cases

  • RESTful API Design: Implement best practices for URL structure, HTTP methods, and status codes.
  • GraphQL Schema Design: Create optimized schemas, handle pagination, and generate resolvers.
  • OpenAPI Specification: Generate and validate OpenAPI specs for documentation and tooling.
  • Versioning Strategies: Implement effective API versioning using URL, header, or content negotiation.
  • Use Case: Design a new microservice API for a user management system, defining its REST endpoints, generating an OpenAPI spec, and planning its versioning strategy.

Quick Start

Use the api-design skill to create a new REST API specification for a user service.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design a REST API with proper URL structure and HTTP methods?▼

REST API design establishes structured resource URLs, validates HTTP method usage, and applies status codes. This Skill provides Python code examples and YAML configurations to implement these best practices for robust service endpoints.

What's the best way to generate and validate OpenAPI specifications for API documentation?▼

OpenAPI specifications standardize API documentation and tooling. This Skill generates and validates OpenAPI specs using YAML configurations, ensuring your RESTful services maintain accurate, structured documentation for microservices.

How do I implement effective API versioning strategies for a new microservice?▼

API versioning manages service evolution through URL paths, headers, or content negotiation. This Skill implements these strategies, allowing you to plan versioning for microservices like a user management system effectively.

Can I create GraphQL schemas with pagination and resolvers using this Skill?▼

GraphQL schema design creates optimized schemas, handles pagination, and generates resolvers. This Skill supports generating paginated GraphQL patterns to structure queries efficiently for your API development.

Does this API design skill support testing endpoints with the requests library?▼

Yes, API testing validates endpoint behavior using the requests dependency. This Skill facilitates testing RESTful services and GraphQL schemas, ensuring your HTTP method usage and resource URLs function correctly.

When do I need OpenAPI specifications versus GraphQL schemas for API development?▼

OpenAPI specs document RESTful services, while GraphQL schemas optimize flexible data queries. This Skill supports both API development approaches, allowing you to choose based on whether you need structured REST endpoints or paginated GraphQL patterns.

Related Skills

Explore More Software Engineering Skills→
djankiesdjankies

VALIDATION-runtime-checks

Define Zod schemas and validate runtime data with TypeScript types.

Community
Intermediate
dev-five-gitdev-five-git
7

devup-api

Generate type-safe API clients from OpenAPI specifications.

Official
Advanced
TibsfoxTibsfox
69

api-design

Design and validate REST API endpoints, methods, and status codes.

Community
Intermediate
Coffelix2023Coffelix2023
1

code-documenter

Generate inline code documentation, API specifications, and developer guides.

Community
Intermediate