Designs Phoenix-centric REST APIs with resource-based patterns and OpenAPI documentation.
npx skills add https://github.com/hwatkins/my-skills --skill api-design-hwatkins
Please help me install this Agent Skill. Skill: api-design Source: https://github.com/hwatkins/my-skills/tree/main/skills/api-design Command: npx skills add https://github.com/hwatkins/my-skills --skill api-design-hwatkins
Designing REST/JSON APIs for Phoenix can be error-prone and hard to scale without consistent patterns. This skill provides a structured approach to resource design, routing, error handling, pagination, authentication, and OpenAPI documentation to keep APIs robust and maintainable.
Outline your API resources and scaffolding, then implement routing and controllers following REST conventions demonstrated for Phoenix.
High-intent search queries and answers about installing and using this skill.
REST API routes in Phoenix should use resource-oriented URL design with consistent HTTP methods and naming conventions. This approach enforces best-practice patterns for endpoints, ensuring predictable behavior and maintainable routing across your project.
Error handling and pagination in a Phoenix REST API require standardized error formats and consistent pagination strategies. Implementing these patterns ensures predictable API responses and scalable data retrieval across all versioned endpoints.
OpenAPI documentation for a Phoenix API is generated by defining standardized response schemas and versioned routes. This provides clear, machine-readable API contracts that enforce consistent endpoint behavior and secure design patterns.
Authentication in Elixir REST APIs is handled by applying secure API design patterns and standardized response schemas. This ensures robust access control across versioned Phoenix routes and predictable error handling for unauthorized requests.
Inconsistent API responses often result from lacking standardized error formats and resource-based URL design. Enforcing consistent HTTP methods, naming conventions, and pagination patterns resolves these scaling issues across Phoenix projects.
oliver-kriskaDesign Elixir Phoenix contexts with bounded principles and Phoenix 1.8+ scope integration.
hffmnnjGenerate API reference documentation from OpenAPI specs and GraphQL schemas.
javierhbrAnalyze Elixir Phoenix code for best practices in controllers, contexts, routing, and plugs.
jstoobzBuild Absinthe-based GraphQL APIs in Elixir with resolver and middleware patterns.
