Reference

In total there are a number of different aspects to using swagger-php. Depending on how custom your requirements are this might be limited to just annotating your code and using the command line tool.

However, swagger-php offers more.

• Attributes

  The new way of adding meta-data to your codebase. Requires PHP 8.1

• Docblock annotations

  The 'traditional' way of documenting your API.

• The Builder

  The \OpenApi\Builder class is the recommended entry point for generating OpenAPI documents from PHP code.

• The Generator

  The \OpenApi\Generator class can be used directly for advanced use cases or via the Builder's withGenerator() method.

• Processors

  swagger-php comes with a list of pre-defined processors that convert the raw data to a complete OpenAPI document. Custom processors can be added or existing removed to tweak swagger-php` to your requirements.