Reference

Depending on how custom your requirements are, using swagger-php might be limited to just annotating your code and running the command line tool.

However, swagger-php offers more.

• Spec attributes

  The attributes in the OpenApi\Spec namespace, read in spec and hybrid mode.

• The Builder

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

• Augmenters

  Augmenters enrich the spec-attributes pipeline with inferred data (types, refs, docblocks) before compilation. They run in three groups: resolve, reduce, and augment.

• Extension points

  The translators and resolvers the spec pipeline runs by default.

• Mergers

  How the spec pipeline decides between two attributes that claim the same key.

• Inheritance

  How PHP class hierarchy maps to OpenAPI allOf composition (schemas) and path prefix composition (PathItems) in the spec pipeline.

Classic

• Classic attributes

  The classic attributes in the OpenApi\Attributes namespace.

• Docblock annotations

  The @OA docblock annotations.

• The Generator

  The \OpenApi\Generator class, used directly or via the Builder's withGenerator() method.

• Processors

  The processors that convert the collected annotation instances into a complete OpenAPI document. Custom processors can be added, and existing ones removed.