Rest Api Design

What it does

This skill assists in designing REST APIs, focusing on proper HTTP methods (GET, POST, PUT, DELETE), resource naming conventions, and request/response structures. It helps ensure the API is well-structured for maintainability and ease of use by clients. The skill can generate API specifications based on provided requirements or critique existing designs.

When to use it

• You're starting a new project and need help designing the API from scratch.
• You have an existing API design that needs review and optimization.
• You want to ensure your API adheres to RESTful principles.
• You're documenting an API for developers and require clear specifications.

Key capabilities

• Generates API specifications.
• Critiques existing API designs.
• Ensures adherence to RESTful principles.
• Provides guidance on resource naming conventions.

Example prompts

• "Design a REST API endpoint for managing user profiles, including create, read, update, and delete operations."
• "Review this API design [paste design] and suggest improvements based on RESTful best practices."
• “Generate an OpenAPI specification for an API that allows users to retrieve product information.”

Tips & gotchas

The skill's output is most effective when provided with clear requirements or a well-defined problem domain. The more context you provide, the better the generated design will be.