Download the PHP package blumilksoftware/openapi-toolbox without Composer

On this page you can find all versions of the php package blumilksoftware/openapi-toolbox. 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 blumilksoftware/openapi-toolbox

Informations about the package openapi-toolbox

Packagist PHP Version Support Packagist Version Packagist Downloads

🧰 openapi-toolbox

OpenAPI Toolbox is a handy package with all important documentation-related features we are using in some of @blumilksoftware projects.

Installation

Install package via Composer and publish configuration file:

If you need it only for internal development (no documentation serving) you can install it with a development flag:

Configuration

Configuration file should be published into your application after running php artisan vendor:publish command. It should look like below:

Features

OpenAPI documentation UI

With configuration openapi_toolbox.ui.enabled = true a documentation UI will be built from configurable path and served on configurable route. Currently, the Stoplight Elements and Swagger UI are only available UI base components configurable by openapi_toolbox.ui.provider setting.

By default, it should be available under GET /documentation.

By changing configuration variable openapi_toolbox.ui.single_source to true, application will serve already built single source file for GUI.

OpenAPI documentation endpoint

Serving a documentation itself can be tricky, especially if specification is built from multiple nested files. Here OpenAPI specification files will be built accordingly to configuration and by default the result should be available under GET /documentation/raw.

OpenAPI specification validation

OpenAPI specification files will be built accordingly to configuration and validated on demand by running an Artisan command:

Good example of usage would be adding this command to CI pipeline for opened pull requests.

Testing requests and responses against OpenAPI specification

Based on kirschbaum-development/laravel-openapi-validator, special trait added to selected PHPUnit test cases enables validation against application's OpenAPI specification:

Every time any HTTP call to application would be performed during tests, additional validation will be performed and structure of requests and responses will be checked against OpenAPI specification. For special cases (e.g. testing invalid requests) this validation can be disabled by using $this->withoutRequestValidation() and $this->withoutResponseValidation().

With configuration openapi_toolbox.cache.enabled = true internal builders will use cached OpenAPI specifications.

All versions of openapi-toolbox with dependencies

PHP Build Version
Package Version
Requires php Version ^8.3
illuminate/config Version ^11.0
illuminate/console Version ^11.0
illuminate/http Version ^11.0
illuminate/support Version ^11.0
kirschbaum-development/laravel-openapi-validator Version ^1.0
krzysztofrewak/openapi-merge Version ^2.1
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 blumilksoftware/openapi-toolbox contains the following files

Loading the files please wait ....