Skip to content

Oestoer/openapi#141

Draft
oestoer wants to merge 10 commits intomasterfrom
oestoer/openapi
Draft

Oestoer/openapi#141
oestoer wants to merge 10 commits intomasterfrom
oestoer/openapi

Conversation

@oestoer
Copy link
Member

@oestoer oestoer commented Jan 18, 2026

After #138

Introduces automatic OpenAPI 3.1 specification generation for the Catalyst application, including documentation, a CLI tool, and a test suite to validate the generated OpenAPI spec. It also demonstrates how to document new API endpoints using POD in controller code.

OpenAPI specification and tooling:

  • Added two new endpoints /openapi and openapi/ui to generate spec and a Swagger View for it.
  • Added a new script script/generate_openapi.pl that generates an OpenAPI 3.1 spec for the Catalyst app by introspecting controllers and their POD documentation. The script supports output in both YAML and JSON, and includes a custom YAML serializer to avoid extra dependencies.
  • Updated README.md with detailed instructions on OpenAPI support, including how to generate the spec, document new endpoints using POD, and test/validate the spec both locally and in Docker.
  • Added a new test file t/openapi_validation.t that validates the generated OpenAPI spec for structure, required fields, and sanity checks on all endpoints and parameters.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant