phoenix-api-gen

What This Skill Does

The phoenix-api-gen skill is a powerful scaffolding engine designed to accelerate the development of Phoenix Framework APIs. It automates the boilerplate-heavy process of building RESTful interfaces, whether you are starting from a formal OpenAPI/Swagger specification or a loose natural language description. By following strict Elixir and Phoenix conventions, the skill ensures that your codebase is production-ready, modular, and maintainable from day one. It handles everything from the database layer (migrations and Ecto schemas) and business logic (contexts) to the transport layer (controllers and views) and testing (ExUnit tests and factories).

Installation

To integrate this skill into your OpenClaw agent, execute the following command in your terminal or agent console: clawhub install openclaw/skills/skills/gchapim/phoenix-api-gen

Use Cases

• Brownfield Projects: Converting existing documentation (OpenAPI YAML) into a functional Phoenix structure.
• Rapid Prototyping: Generating CRUD endpoints for new business domains by simply describing your entities and relationships.
• Standardization: Ensuring all team members follow established patterns for multi-tenancy, authorization plugs, and context-based API design.
• Test-Driven Development: Automatically scaffolding tests and factories to ensure your business logic is verified upon generation.

Example Prompts

1. "Generate a Phoenix API for a task management system. Resources: Project (name: string, description: text) and Task (title: string, completed: boolean, due_date: datetime). Ensure multi-tenancy based on organization_id."
2. "Import this OpenAPI spec file located at ./docs/api.yaml and scaffold the necessary contexts, controllers, and tests, including bearer token authentication for all routes."
3. "Scaffold an 'Inventory' context for my existing Phoenix project with a 'Product' resource. Include CRUD operations, a fallback controller for error handling, and ExUnit tests with factories."

Tips & Limitations

• Context Boundaries: The tool works best when you explicitly define domain boundaries. Grouping resources effectively allows for cleaner, decoupled contexts.
• Validation: Always verify the generated changesets. While the tool generates robust default validations, business-specific constraints may require manual adjustments.
• Multi-Tenancy: When using multi-tenancy features, remember to run the migrations in the correct order to ensure indexes exist before application logic relies on them.
• Security: The skill provides templates for API Key and Bearer token auth; however, always ensure these are integrated into your router.ex pipeline with the appropriate scopes. It is designed for internal architecture generation and should be audited during code review.