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 Generate interactive documentation for your RESTful API using PHP attributes (preferred) or 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, 3.1 and 3.2 specification.
- Extracts information from code and existing phpdoc comments.
- Can be used programmatically or via command-line tool.
- Documentation site with a getting started guide.
- Error reporting (with hints, context).
- All metadata is configured via PHP attributes.
OpenAPI version support
swagger-php allows to generate specs either for OpenAPI 3.0.0, OpenAPI 3.1.0 and OpenAPI 3.2.0.
By default, the spec will be in version 3.0.0. The command line option --version may be used to change to
any other supported version.
Programmatically, the method Generator::setVersion() can be used to change the version.
Requirements
swagger-php requires at least PHP 8.2.
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.
If your code uses doctrine annotations you will need to install that library manually:
Usage
Use OpenAPI attributes to add metadata to your classes, methods and other structural PHP elements.
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.
Automatic type resolution
As of version 6, resolving of types is done using the TypeInfoTypeResolver class. It uses the symfony/type-info
library under the hood which allows handling of complext types.
With this change, swagger-php supports all available native type-hints and also complext generic type-hints via phpdoc
blocks.
This simplifies the definition of schemas.
For example, the following two examples are now equivalent:
If this is not desired, the LegacyTypeResolver can be used to preserve the old behaviour of version 5.
The LegacyTypeResolver is deprecated and will be removed in a future release.
Contributing
More on OpenApi & Swagger
All versions of swagger-php with dependencies
nikic/php-parser Version ^4.19 || ^5.0
phpstan/phpdoc-parser Version ^2.0
psr/log Version ^1.1 || ^2.0 || ^3.0
radebatz/type-info-extras Version ^1.0.2
symfony/console Version ^7.4 || ^8.0
symfony/deprecation-contracts Version ^2 || ^3
symfony/finder Version ^5.0 || ^6.0 || ^7.0 || ^8.0
symfony/yaml Version ^5.4 || ^6.0 || ^7.0 || ^8.0