Regenerate Phoenix OpenAPI specifications from OpenApiSpex code to prevent spec drift.
npx skills add https://github.com/agoodway/GoodSkills --skill openapi-agoodway
Please help me install this Agent Skill. Skill: openapi Source: https://github.com/agoodway/GoodSkills/tree/main/skills/openapi Command: npx skills add https://github.com/agoodway/GoodSkills --skill openapi-agoodway
Keeps Phoenix applications using open_api_spex from drifting out of sync by regenerating the OpenAPI specification directly from live controller operations and schema modules.
Ask the AI to regenerate your OpenAPI spec by running the OpenAPI regenerate workflow for your Phoenix app, updating the existing openapi.json or openapi.yaml in the project root.
High-intent search queries and answers about installing and using this skill.
To regenerate OpenAPI specs in Phoenix, locate your OpenApiSpex ApiSpec module and run mix openapi.spec.json or mix openapi.spec.yaml. This rebuilds the specification directly from your updated controller operations and schema modules to eliminate documentation drift.
Spec drift occurs when you change controller actions or OpenApiSpex schema modules without regenerating the published openapi.json or openapi.yaml file. Regenerating the specification directly from the live ApiSpec implementation ensures your documentation matches your current codebase.
The OpenAPI spec regeneration workflow detects which format exists in your project root. It regenerates openapi.json, openapi.yaml, or both if both files are present, selecting the appropriate mix openapi.spec command based on your existing files.
Missing endpoints in a regenerated Phoenix OpenAPI specification are typically caused by controller actions lacking OpenApiSpex.operation metadata. The regeneration process surfaces compilation errors and highlights these likely causes so you can add the missing operation definitions.
The best way to validate changes after regenerating an OpenAPI spec from open_api_spex is to diff the newly generated specification against the previous version. This highlights any unexpected endpoint or schema modifications before you publish the updated documentation.
mkreymanRun Mix-based quality checks for Elixir/Phoenix projects.
Vivekmano27Generate OpenAPI 3.0 documentation from NestJS and Django REST Framework codebases.
mkreymanGenerate Phoenix contexts, schemas, LiveViews, and controllers via mix phx.gen commands.
agoodwayBootstrap OpenAPI 3.0 specs and API-key authentication in Phoenix apps.
