API Designer

Name: API Designer
Availability: InStock
Author: daffy0208

Design REST and GraphQL APIs with naming, versioning, authentication, and documentation.

34|7|Updated Oct 22, 2025

Search Tags:#versioning #documentation #authentication #api #backend #rest #graphql

Ready to run

npx skills add https://github.com/daffy0208/ai-dev-standards --skill api-designer-daffy0208

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: API Designer
Source: https://github.com/daffy0208/ai-dev-standards/tree/main/SKILLS/api-designer
Command: npx skills add https://github.com/daffy0208/ai-dev-standards --skill api-designer-daffy0208

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates the complexity and uncertainty of API design by providing comprehensive guidance on RESTful principles, GraphQL patterns, authentication, versioning, and documentation.

Core Features & Use Cases

REST API Design: Create RESTful endpoints with proper HTTP methods, status codes, and resource naming.
GraphQL Schema Development: Design GraphQL schemas with queries, mutations, and pagination.
Use Case: Imagine you need to build a user management system. Use this Skill to design both REST endpoints for simple CRUD operations and GraphQL queries for complex data relationships.

Quick Start

Use the API Designer skill to create a REST API for user management with JWT authentication and OpenAPI documentation.

Frequently Asked Questions about API Designer

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

FAQPage Schema

How do I design REST API endpoints with proper HTTP methods and status codes?▼

REST API design uses HTTP methods (GET, POST, PUT, DELETE) mapped to resource operations with appropriate status codes. This Skill guides you through naming conventions, status code selection, and RESTful principles to create consistent, scalable endpoints that clients can predict and rely on.

What's the best way to version REST and GraphQL APIs?▼

API versioning manages breaking changes by maintaining multiple endpoint versions or schema versions simultaneously. This Skill covers versioning strategies for both REST (URL paths, headers) and GraphQL (schema evolution) to ensure backward compatibility and smooth client migrations.

How do I implement authentication and authorization in APIs?▼

Authentication verifies client identity; authorization controls what authenticated clients can access. This Skill teaches JWT token implementation, secure credential handling, and permission patterns for both REST and GraphQL APIs to protect your backend resources.

How do I document REST and GraphQL APIs for developers?▼

API documentation includes OpenAPI/Swagger specs for REST and GraphQL schema definitions that describe endpoints, fields, and operations. This Skill shows you how to generate and maintain machine-readable documentation that keeps client and server definitions in sync.

What are best practices for error handling and pagination in APIs?▼

Error handling returns structured, predictable responses with clear codes and messages; pagination splits large datasets into manageable chunks. This Skill covers designing consistent error formats and cursor or offset-based pagination for both REST and GraphQL to improve reliability and performance.

Can I use this for both simple CRUD operations and complex data relationships?▼

Yes. REST works well for straightforward CRUD with dedicated endpoints; GraphQL excels at complex, nested relationships in a single query. This Skill teaches you to choose the right approach for your use case and design schemas that match your data model.