Download the PHP package spiral-packages/swagger-php without Composer

On this page you can find all versions of the php package spiral-packages/swagger-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Example code of spiral-packages/swagger-php

Informations about the package swagger-php

Swagger-php

PHP Version Require Latest Stable Version phpunit psalm Codecov Total Downloads type-coverage psalm-level

zircote/swagger-php integration package for Spiral Framework.

Requirements

Make sure that your server is configured with following PHP version and extensions:

Installation

You can install the package via composer:

To enable the package in your Spiral Framework application, you will need to add the Spiral\OpenApi\Bootloader\SwaggerBootloader class to the list of bootloaders in your application:

Note If you are using spiral-packages/discoverer, you don't need to register bootloader by yourself.

Configuration

The configuration file should be located at app/config/swagger.php, and it allows you to set options. Here is an example of how the configuration file might look:

Usage

First, create an entity that represents the resource you want to document. For example, you can create a User entity that represents a user resource:

Next, create a Controller that handles the actions for the resource, and add Swagger attributes to the actions to describe the behavior of the endpoint. For example, you can create a UserController that handles the list action for the User resource:

Some elements like page, limit, direction parameters. The ResponseCollectionMeta schema can be used in a variety of places. Therefore, they can be defined in the configuration file:

The package provides a Spiral\OpenApi\Controller\DocumentationController controller that can render the documentation in various formats such as HTML, JSON, and YAML. The HTML format uses the Swagger UI for displaying the documentation. To use this controller, it is necessary to add a route in the App\Application\Bootloader\RoutesBootloader file:

Testing

License

The MIT License (MIT). Please see License File for more information.

All versions of swagger-php with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
spiral/boot Version ^3.5
spiral/config Version ^3.5
spiral/core Version ^3.5
spiral/views Version ^3.5
spiral/cache Version ^3.5
spiral/http Version ^3.5
zircote/swagger-php Version ^4.8
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package spiral-packages/swagger-php contains the following files

Loading the files please wait ....