gcgov / framework-service-documentation
Plugin that enables a route to generate OpenAPI yaml documentation at the /documentation.yaml route
Package info
github.com/gcgov/framework-service-documentation
Type:framework-service
pkg:composer/gcgov/framework-service-documentation
v1.1.1
2026-06-08 17:43 UTC
Requires
- php: >=8.1
- doctrine/annotations: ^2.0
- zircote/swagger-php: ^6.1
Requires (Dev)
- gcgov/framework: dev-main
- jetbrains/phpstorm-attributes: ^1.0
- phpstan/phpstan: ^2.1
- phpunit/phpunit: ^10.5
This package is auto-updated.
Last update: 2026-06-08 17:44:09 UTC
README
Service to extend gcgov/framework
Primary purpose
- Adds route /documentation.yaml to application that, when accessed, uses the zircote/swagger-php library to scan the \app and \gcgov\framework namespaces for open api documentation annotations and attributes and generates a comprehensive open api documentation yaml file that can be loaded into Swagger UI for integrated API documentation