api-architect
OfficialDesign robust APIs
AuthorCure-Consulting-Group
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill provides a comprehensive framework for designing production-ready REST and GraphQL APIs, ensuring consistency, security, and maintainability.
Core Features & Use Cases
- API Type Classification: Guides selection between REST, GraphQL, WebSockets, etc., based on needs.
- Design Standards: Defines clear conventions for URL structure, HTTP methods, status codes, and request/response formats.
- Authentication & Rate Limiting: Outlines strategies for secure authentication (JWT, API Keys) and effective rate limiting.
- Versioning & Documentation: Establishes versioning strategies and emphasizes OpenAPI 3.0 documentation.
- Error Handling: Standardizes error codes and response formats for better debugging and client experience.
- Use Case: Design a new public-facing API for a e-commerce platform, ensuring it adheres to best practices for versioning, authentication, and error handling.
Quick Start
Design a REST API for managing user profiles, including versioning, authentication, and error handling standards.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: api-architect Download link: https://github.com/Cure-Consulting-Group/ProductEngineeringSkills/archive/main.zip#api-architect Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.