Audit API endpoints for RESTful HTTP method and resource naming conventions.
npx skills add https://github.com/yanko-belov/code-craft --skill rest-conventions
Please help me install this Agent Skill. Skill: rest-conventions Source: https://github.com/yanko-belov/code-craft/tree/main/skills/rest-conventions Command: npx skills add https://github.com/yanko-belov/code-craft --skill rest-conventions
RESTful API designs often violate HTTP semantics by using verbs in URLs or misusing HTTP methods, which leads to brittle integrations and poor caching behavior.
Review your API endpoints and replace verbs in URLs with nouns, and ensure HTTP methods align with CRUD actions.
High-intent search queries and answers about installing and using this skill.
Using verbs in REST API URLs violates HTTP semantics and leads to brittle integrations and poor caching behavior. Naming endpoints with nouns ensures HTTP methods correctly define the resource operations.
To fix REST anti-patterns like using POST for reads, audit your API surface and align HTTP methods with CRUD actions. Replace verbs in URLs with nouns to ensure proper resource operations and consistent design.
Canonical RESTful design maps HTTP methods to CRUD actions, ensuring GET retrieves, POST creates, PUT/PATCH updates, and DELETE removes resources. This alignment provides a consistent, semantic API surface.
Structuring nested resources in REST API design requires following canonical patterns for resource naming. This ensures a consistent API surface and clear hierarchical relationships between parent and child resources.
Refactoring endpoints to follow REST may require migrating existing integrations. While it improves clarity and evolvability, you must follow specific migration guidance to avoid breaking current clients during the transition.
michaelsvanbeekDefine REST API design patterns and contract standards for endpoints and OpenAPI documentation.
somachakGenerate OpenAPI 3.0 documentation, changelogs, and TypeScript/Python client SDK scaffolds.
ryasrkProvide guidelines for designing RESTful APIs with resource naming and HTTP methods.
iludeDesign REST and GraphQL APIs with language-agnostic patterns for routes, schemas, and specs.
