open-api

2.2.0 (2023-11-23)

New

• Added a controller that exposes three endpoints:
  • The OpenApi spec
  • A Redoc UI
  • A Swagger UI
• Added a new route registrar class:
  • Registers routes from a cache file or at runtime from the OpenApi yaml spec.
  • Automatically registers /openapi/spec route that exposes the OpenApi spec.
  • Automatically registers /openapi/docs route that exposes a Swagger or Redoc UI.

New

• Added a new route registrar class:
  • Automatically registers /openapi/spec route that exposes the OpenApi spec.
  • Automatically registers /openapi/swagger route that exposes a Swagger UI instance.

New

• Now possible to specify the OpenApi version when generating the spec (3.0.0 or 3.1.0).

Fixed

• The spec generator now supports the new Mako 10 directory structure as well as the legacy structure.

• Bumped requirements to Mako 10+ and PHP 8.1+

Fixed

• A format is no longer required for integers.

Fixed

• It is now possible to specify the output path of the generated route file.

Fixed

• Parameters are now supported on both the path level and the operation level.

Fixed

• The OpenApiTrait::getRouteName() method now supports invokable classes.

New

• Added no-dot path parameter pattern.
• Added possibility of defining custom regex based path parameter patterns.

Fixed

• Only base route parameter patterns on path parameters.

New

• Added a helper trait with the following methods:
  • OpenApiTrait::getRouteName()
• Added experimental support for route parameter patterns based on parameter formats.

Fixed

• Path parameters are parsed on path level instead of on request method level.

• Initial release