Api Design

What it does

The affaan-m-api-design skill enables AI agents to design and structure RESTful APIs with best practices, including route planning, request/response formatting, and versioning strategies. It also supports generating API documentation in formats like Swagger or OpenAPI.

When to use it

• You need to create a new API for a web application or microservice architecture.
• You want to ensure your API follows RESTful conventions and is scalable.
• Your team requires well-documented APIs for integration with third-party services.
• You're refactoring an existing API to improve its structure and usability.

Key capabilities

• Generate RESTful endpoint structures based on user requirements.
• Create OpenAPI/Swagger documentation automatically.
• Suggest versioning strategies (e.g., URL path, header-based).
• Provide guidance on request/response formats (JSON, XML).
• Offer security recommendations like authentication and rate limiting.

Example prompts

• "Design a RESTful API for a task management application with endpoints for creating, updating, and deleting tasks."
• "Generate OpenAPI documentation for an e-commerce API that includes user authentication and product listings."
• "Suggest a versioning strategy for a public-facing API that needs to support backward compatibility."

Tips & gotchas

• Ensure your requirements are clearly defined before using the skill to avoid ambiguity in endpoint design.
• While the skill provides documentation templates, manually review them for accuracy and completeness.