Skip to content

Swagger-PHP

Generate OpenAPI documentation for your RESTful API.

1. Install with composer: ​

shell
> composer require zircote/swagger-php

2. Update your code ​

Add swagger-php attributes (or legacy annotations) to your source code.

⚠️ The doctrine/annotations library used to parse annotations is going to be deprecated, so wherever possible attributes should be used.

spec attributes

Since 6.5.0 there is a second set of attributes - typed objects you can also build by hand, with validation and version handling in the pipeline rather than in the attributes. They run in spec mode:

shell
> ./vendor/bin/openapi -m spec ...

3. Generate OpenAPI documentation ​

shell
> ./vendor/bin/openapi src -o openapi.yaml

4. Explore and interact with your API ​

Use an OpenAPI tool like Swagger UI or Scalar to explore and interact with your API.