Swagger-PHP

Appearance

Under the hood ​

Processing flow ​

  • The Generator iterates over the given sources (Symfony Finder, file/directory list, etc.)
  • The configured analyser (AnalyserInterface) reads the files and builds an Analysis object. The default is the ReflectionAnalyser.
  • The Analysis object and its annotations are then processed by the configured processors.
  • If enabled, the analysis/annotations are validated.
  • The root OpenApi annotation then contains all annotations and is serialized into YAML/JSON.

Context ​

Each annotation is associated with a unique Context instance. This contains details, collected by the parser/analyser, about the PHP context where the annotation was found.

Typically, there will be a processor that uses the data to augment the annotation.

Examples of the data collected:

  • class/interface/trait/enum names
  • property names
  • doctype or native type hints
  • file name and line number

Analysis ​

Contains all detected annotations and other relevant meta-data.

It uses a SplObjectStorage instance to store the parsed annotations.

Documentation ​

This documentation is generated with VitePress

Installation ​

shell
cd docs
npm install

Workflow ​

  • Edit .md files in the docs folder — see the toolchain notes for which pages are generated from source and must not be edited by hand, and for the commands
  • Create PR and update master
  • Manually trigger the gh-pages workflow to update the online docs.

The last step requires committing rights on zircote/swagger-php.