Download the PHP package zircote/swagger-php without Composer
On this page you can find all versions of the php package zircote/swagger-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download zircote/swagger-php
More information about zircote/swagger-php
Files in zircote/swagger-php
Package swagger-php
Short Description swagger-php - Generate interactive documentation for your RESTful API using phpdoc annotations
License Apache-2.0
Homepage https://github.com/zircote/swagger-php/
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Rated 4.86 based on 37 reviews
Informations about the package swagger-php
swagger-php
Generate interactive OpenAPI documentation for your RESTful API using PHP attributes (preferred) or
doctrine annotations (requires additional doctrine/annotations library).
See the documentation website for supported attributes and annotations.
Annotations are deprecated and may be removed in a future release of swagger-php.
Features
- Compatible with the OpenAPI 3.0 and 3.1 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)
- As of PHP 8.1 all annotations are also available as PHP attributes
OpenAPI version support
swagger-php allows to generate specs either for OpenAPI 3.0.0 or OpenAPI 3.1.0.
By default the spec will be in version 3.0.0. The command line option --version may be used to change this
to 3.1.0.
Programmatically, the method Generator::setVersion() can be used to change the version.
Requirements
swagger-php requires at least PHP 7.2 for annotations and PHP 8.1 for using attributes.
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.
doctrine/annotations
As of version 4.8 the doctrine annotations library is optional and no longer installed by default.
To use PHPDoc annotations this needs to be installed on top of swagger-php:
If your code uses PHPDoc annotations you will need to install this as well:
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.
Documentation of how to use the Generator class can be found in the Generator reference.
Usage from the Command Line Interface
The openapi command line interface can be used to generate the documentation to a static yaml/json file.
Starting with version 4 the default analyser used on the command line is the new ReflectionAnalyser.
Using the --legacy flag (-l) the legacy TokenAnalyser can still be used.
Usage from the Deserializer
Generate the OpenApi annotation object from a json string, which makes it easier to manipulate objects programmatically.
Contributing
More on OpenApi & Swagger
All versions of swagger-php with dependencies
ext-json Version *
psr/log Version ^1.1 || ^2.0 || ^3.0
symfony/deprecation-contracts Version ^2 || ^3
symfony/finder Version >=2.2
symfony/yaml Version >=3.3