cbswagger

What problem does it solve?

Generating accurate, up-to-date OpenAPI documentation for ColdBox/BoxLang REST APIs can be manual, inconsistent, and easily drift from the codebase; this skill automates extraction of endpoint metadata from handler annotations and schema files so documentation stays synchronized with implementation.

Core Features & Use Cases

• Annotation-driven spec generation: Scan ColdBox handlers and action-level JSDoc annotations to produce OpenAPI 3.x JSON.
• Schema management: Load shared JSON schema files for request and response shapes to avoid duplication.
• Security and UI integration: Define JWT/Bearer security schemes, host Swagger UI and ReDoc endpoints, and configure json output paths for CI/CD.
• Use Case: A backend team annotates handlers and runs the generator in CI to commit a canonical spec and publish a protected developer UI.

Quick Start

Scan the project's ColdBox handlers and generate a complete OpenAPI 3.0 JSON specification using cbswagger configuration and handler annotations.