What is Swagger-PHP?
swagger-php
is a library that extracts API metadata from your PHP source code files.
The idea is to add swagger-php
annotations or attributes next to the relevant PHP code in your application. These will contain the details about your API and swagger-php
will convert those into machine-readable OpenAPI documentation.
By adding your API documentation next to the corresponding source code (same file!) makes it easy to keep it up-to-date as all details can be modified in one place.
Annotating vs. Annotations
When talking about annotating your code we mean the act of adding meta-data to your codebase. This can be done by either adding Annotations
or Attributes
.
Requirements
Using swagger-php
requires a minimum of PHP 7.2 for using annotations and at least PHP 8.1 to use attributes.