Download the PHP package mymdz/swagger-php without Composer
On this page you can find all versions of the php package mymdz/swagger-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mymdz/swagger-php
More information about mymdz/swagger-php
Files in mymdz/swagger-php
Package swagger-php
Short Description Swagger-PHP - Generate interactive documentation for your RESTful API using phpdoc annotations
License
Informations about the package swagger-php
swagger-php
Generate interactive OpenAPI documentation for your RESTful API using doctrine annotations.
Features
- Compatible with the OpenAPI 3.0 specification.
- Extracts information from code & existing phpdoc annotations.
- Command-line interface available.
- Documentation site with a getting started guide.
- Exceptional error reporting (with hints, context)
Installation (with Composer)
For cli usage from anywhere install swagger-php globally and make sure to place the ~/.composer/vendor/bin
directory in your PATH so the openapi
executable can be located by your system.
Usage
Add annotations to your php files.
Visit the Documentation website for the Getting started guide or look at the Examples directory for more examples.
Usage from php
Generate always-up-to-date documentation.
Usage from the Command Line Interface
Generate the documentation to a static json file.
Usage from the Deserializer
Generate the OpenApi annotation object from a json string, which makes it easier to manipulate objects programmatically.
Usage from docker
Generate the swagger documentation to a static json file.
More on OpenApi & Swagger
- https://swagger.io
- https://www.openapis.org
- OpenApi Documentation
- OpenApi Specification
- Related projects
Contributing
Feel free to submit Github Issues or pull requests.
The documentation website is build from the vuepress.
Make sure pull requests pass PHPUnit and PHP_CodeSniffer (PSR-2) tests.
To run both unittests and linting execute:
Running only unittests:
Running only linting: