Api Design Expert

What it does

This skill empowers AI agents to generate robust, production-ready API specifications and code scaffolds. It focuses on creating clear documentation and structural blueprints for backend services based on user requirements.

When to use it

• You need to define a new REST or GraphQL endpoint structure before writing implementation code.
• Your team requires standardized OpenAPI (Swagger) or Postman collection formats for testing.
• You are prototyping a service and need immediate, syntactically correct boilerplate code.
• You want to ensure consistent naming conventions and error handling patterns across your backend.

Key capabilities

• Generates comprehensive API documentation in standard formats like OpenAPI/Swagger.
• Creates functional code scaffolds for common backend languages and frameworks.
• Designs logical endpoint hierarchies and resource relationships.
• Defines request/response schemas, data types, and validation rules.

Example prompts

• "Design a REST API specification for a user authentication service including login, logout, and profile endpoints."
• "Generate an OpenAPI 3.0 document for a product inventory system with CRUD operations."
• "Create a Python FastAPI scaffold for a payment processing gateway with proper error handling."

Tips & gotchas

Ensure you provide specific context about your preferred technology stack (e.g., Node.js, Go) and security requirements to get relevant output. This skill generates structural designs; it does not automatically connect to existing databases or handle live network traffic.