OpenAPI conformant
Generate OpenAPI documents in version 3.0 or 3.1.
Swagger-PHP
Generate OpenAPI documentation for your RESTful API.
Document your API inside PHP source code
Using swagger-php lets you write the API documentation inside the PHP source files which helps keeping the documentation up-to-date.
Annotation and Attribute support
Annotations can be either docblocks or PHP 8.1 attributes.
1. Install with composer:
shell
> composer require zircote/swagger-php2. Update your code
Add swagger-php attributes (or legacy annotations) to your source code.
⚠️ The doctrine/annotations library used to parse annotation is going to be deprecated, so wherever possible attributes should be used.
3. Generate OpenAPI documentation
shell
> ./vendor/bin/openapi src -o openapi.yaml4. Explore and interact with your API
Use an OpenAPI tool like Swagger UI or Scalar to explore and interact with your API.