api-design-expert
API Design Expert provides comprehensive guidance on building scalable APIs using REST, GraphQL, and other modern patterns. Learn resource-oriented design, stateless architecture, versioning strategies, and critical practices like authentication, rate limiting, and structured error handling to ensure your APIs are secure, maintainable, and performant.
API Design Expert teaches REST architecture, GraphQL, versioning strategies, and API best practices for building robust services.
AI-generated summary based on this skill's SKILL.md
Install
personamanagmentlayer/pcl/api-design-expert · repository language: TypeScript
git clone https://github.com/personamanagmentlayer/pcl
cp -r pcl/stdlib/api/api-design-expert ~/.claude/skills/api-design-expertnpx skillfed install personamanagmentlayer/pcl/api-design-expertFrequently asked questions
AI-generated answers based on this skill's SKILL.md and metadata
How to design REST APIs that follow best practices?
API Design Expert teaches resource-oriented design principles for REST APIs, emphasizing stateless architecture, proper HTTP method usage, and meaningful URI structures. The skill covers designing endpoints that are intuitive, scalable, and maintainable, including practices like using nouns for resources, implementing pagination, and structuring responses consistently. You'll learn how to create APIs that are easy for developers to understand and integrate with.
What are the key RESTful API principles I should follow?
API Design Expert outlines core RESTful principles including client-server separation, statelessness, uniform interfaces, and resource-based design. The skill emphasizes using standard HTTP methods (GET, POST, PUT, DELETE) correctly, designing hierarchical resource paths, implementing proper status codes, and following HATEOAS patterns for discoverability. These principles ensure your APIs are predictable, scalable, and aligned with web standards.
How do I version my API and maintain backward compatibility?
API Design Expert covers multiple API versioning strategies, including URL path versioning, header-based versioning, and query parameter approaches. The skill teaches backward compatibility techniques to prevent breaking existing client integrations when evolving your API. You'll learn when to version, how to deprecate endpoints gracefully, and strategies for managing multiple API versions simultaneously in production environments.
How should I implement API authentication and security?
API Design Expert provides guidance on securing APIs through authentication mechanisms like JWT token verification, OAuth 2.0, and API keys. The skill covers rate limiting implementation strategies to prevent abuse, input validation techniques, and HTTPS enforcement. You'll learn how to design security layers that protect your API while maintaining performance and usability for legitimate clients.
What error handling and response formats work best for APIs?
API Design Expert teaches structured error handling approaches, including consistent error response formats with meaningful status codes, error messages, and error codes. The skill emphasizes designing responses that help developers debug issues quickly while maintaining security by not exposing sensitive system details. You'll learn patterns for handling validation errors, authentication failures, and server-side exceptions gracefully.
How does GraphQL compare to REST for API design?
API Design Expert compares REST, GraphQL, gRPC, and WebSocket approaches, helping you choose the right style for your use case. GraphQL offers flexible querying and reduced over-fetching, while REST provides simplicity and HTTP caching benefits. The skill explores trade-offs in complexity, performance, caching strategies, and developer experience, enabling informed architectural decisions for your API platform.
SKILL.md
rendered from the published skill — quoted content, verbatim
API Design Expert
Expert guidance for API design, RESTful principles, GraphQL, versioning strategies, and API best practices.
Core Concepts
API Design Principles
- RESTful architecture
- Resource-oriented design
- Uniform interface
- Statelessness
- Cacheability
- Layered system
API Styles
- REST (Representational State Transfer)
- GraphQL
- RPC (Remote Procedure Call)
- WebSocket
- Server-Sent Events (SSE)
- gRPC
Key Considerations
- Versioning strategies
- Authentication and authorization
- Rate limiting
- Error handling
- Documentation
- Backward compatibility
REST API Design
```python from fastapi import FastAPI, HTTPException, Query, Path, Header from pydantic import BaseModel, Field from typing import List, Optional from datetime import datetime from enum import Enum
app = FastAPI( title="User Management API", version="1.0.0", description="RESTful API for user
(truncated - see the full file via the links below)
Read as markdown · JSON record · Browse the source repository
File tree — 1 file
stdlib/api/api-design-expert/SKILL.md