bootstrap-openapi

Bootstrap OpenAPI 3.0 specs and API-key authentication in Phoenix apps.

1|Updated May 7, 2026
One-click install
npx skills add https://github.com/agoodway/GoodSkills --skill bootstrap-openapi
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bootstrap-openapi
Source: https://github.com/agoodway/GoodSkills/tree/main/skills/bootstrap-openapi
Command: npx skills add https://github.com/agoodway/GoodSkills --skill bootstrap-openapi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It eliminates the effort of hand-wiring OpenAPI documentation and authentication in a Phoenix app by bootstrapping a complete OpenAPI spec plus API-key based security.

Core Features & Use Cases

  • OpenAPI 3.0 + Swagger UI: Generates an OpenAPI spec and serves Swagger UI for your Phoenix routes.
  • API-key authentication with authorization: Implements bearer-token authentication for read-only (pk_) and read/write (sk_) API keys.
  • Multi-tenant access model: Adds Account + AccountUser membership with role-based access and scopes API keys to user+account.

Quick Start

Tell your AI agent: “Bootstrap OpenAPI for my existing Phoenix project at /bootstrap-openapi, including multi-tenant accounts, API key auth, Swagger UI, CORS, and the required router and auth plug wiring.”

Frequently Asked Questions about bootstrap-openapi

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add OpenAPI documentation and Swagger UI to a Phoenix app?

You can bootstrap OpenAPI documentation in a Phoenix app by generating an OpenAPI 3.0 spec via open_api_spex and serving Swagger UI for your routes. This automates spec creation and UI wiring without manual setup.

What's the best way to set up multi-tenant API key authentication in Phoenix?

Setting up multi-tenant API key authentication in Phoenix involves creating Account and AccountUser membership models with role-based access. API keys are scoped to both user and account, using prefix and hash token validation for secure access.

How does bearer token verification work for Phoenix controllers with read and write API keys?

Bearer token verification in Phoenix uses auth plugs to verify API keys, distinguishing between read-only keys prefixed with pk_ and read/write keys prefixed with sk_. This controls programmatic endpoint access based on token scopes.

Can I configure global security for my OpenAPI spec in a Phoenix project?

Yes, you can configure global security for an OpenAPI spec in a Phoenix project. The bootstrap process wires Phoenix auth plugs for bearer verification and applies a global security configuration to your generated OpenAPI 3.0 documentation.

Do I need an existing Phoenix project to bootstrap multi-tenant OpenAPI and API auth?

Yes, you need an existing Phoenix project to bootstrap multi-tenant OpenAPI and API auth. The process integrates open_api_spex for OpenAPI 3.0 generation, auth plug wiring, and multi-tenant Account models directly into your current application structure.