Rest Conventions

What it does

This skill enforces RESTful API design conventions. It ensures that endpoints are properly structured, HTTP methods are used correctly (GET, POST, PUT, DELETE), and responses adhere to standard practices like using appropriate status codes. The goal is to create predictable and maintainable APIs.

When to use it

• Designing a new API: Use this skill from the start to ensure your API follows REST principles.
• Refactoring an existing API: Apply this skill to improve the consistency and clarity of an older, less structured API.
• Generating API documentation: The skill can help produce accurate and standardized documentation for developers using your API.
• Reviewing code for API development: Use it as a linter or style checker during code reviews.

Key capabilities

• Enforces RESTful endpoint structure
• Validates HTTP method usage (GET, POST, PUT, DELETE)
• Ensures proper HTTP status code responses
• Supports standardized response formats

Example prompts

• "Generate a REST API endpoint for creating a new user."
• "Review this API code and ensure it follows REST conventions."
• "Suggest improvements to make this API more RESTful."

Tips & gotchas

This skill is most effective when used early in the development process. It assumes a basic understanding of REST principles; it won't teach you those concepts directly, but rather enforce them.