gcgov/framework-service-documentation

Plugin that enables a route to generate OpenAPI yaml documentation at the /documentation.yaml route

v1.0.4 2024-08-27 13:36 UTC

Requires

• php: >=8.1
• doctrine/annotations: ^2.0
• zircote/swagger-php: ^4.8

MIT

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