afrexai-api-architect

What problem does it solve?

This Skill provides a comprehensive framework for designing, building, testing, documenting, and securing production-grade APIs across their entire lifecycle.

Core Features & Use Cases

• API Design: Resource modeling, naming conventions, HTTP method selection, status code mapping.
• OpenAPI Specification: Generating and validating OpenAPI 3.1 specs.
• Implementation Patterns: Request validation, error handling, idempotency, rate limiting.
• Testing Strategy: API test pyramid, endpoint checklists, contract testing.
• Security: Comprehensive security checklist, CORS configuration.
• Versioning & Deprecation: Strategies and playbook.
• Monitoring & Observability: Key metrics, structured logging, health checks.
• GraphQL Guidance: Schema design and anti-patterns.
• Edge Cases: Timezone handling, large payloads, webhooks.
• Use Case: A developer needs to design a new REST API for a microservice. They can use this Skill to follow best practices for resource modeling, define clear API contracts using OpenAPI, implement robust error handling and security measures, and set up a testing strategy.

Quick Start

Use the afrexai-api-architect skill to design a new API for managing user profiles.