api-design

Name: api-design
Availability: InStock
Author: Lucas

Design RESTful and GraphQL APIs with OpenAPI standards and versioning.

Updated Jan 27, 2026

Search Tags:#design #versioning #api #openapi #backend #rest #graphql

Ready to run

npx skills add https://github.com/zagarlucas/zagarlucas.github.io --skill api-design-zagarlucas

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/zagarlucas/zagarlucas.github.io/tree/main/.continue/skills/api-design
Command: npx skills add https://github.com/zagarlucas/zagarlucas.github.io --skill api-design-zagarlucas

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Design RESTful and GraphQL APIs with consistent best practices. Use when creating new APIs, refactoring existing endpoints, or documenting API specifications. Handles OpenAPI, REST, GraphQL, versioning.

Core Features & Use Cases

Standardized API design for REST, GraphQL, and OpenAPI across projects.
Specification generation and documentation scaffolding for backend services.
Real-world scenarios include starting a new microservice, refactoring endpoints, and publishing versioned APIs.

Quick Start

Create a baseline OpenAPI specification for a new service and document its REST and GraphQL endpoints.

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 consistent resource naming and pagination?▼

To design a REST API with consistent resource naming and pagination, apply standardized best practices for HTTP methods, status codes, and error schemas to ensure robust and reliable backend service endpoints.

What's the best way to generate an OpenAPI specification for a new microservice?▼

The best way to generate an OpenAPI specification for a new microservice is to scaffold documentation and define schemas using standardized API design principles, ensuring proper versioning and endpoint documentation from the start.

How does GraphQL schema design differ from REST API best practices?▼

GraphQL schema design differs from REST by applying GraphQL-specific standards across versioning, documentation, and schema design, while REST focuses on resource naming, HTTP methods, and pagination conventions.

Can I use this approach to refactor existing API endpoints and add authentication?▼

Yes, you can refactor existing API endpoints and add authentication by applying consistent REST, GraphQL, and OpenAPI standards to update resource naming, status codes, and security schemas in real-world projects.

When do I need to implement API versioning and standardized error schemas?▼

You need to implement API versioning and standardized error schemas when publishing APIs, refactoring endpoints, or starting new microservices to maintain backward compatibility and consistent error handling across backend services.