Download the PHP package greensight/laravel-openapi-testing without Composer

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

Informations about the package laravel-openapi-testing

Laravel OpenApi Testing

Deprecated, use https://github.com/ensi-platform/laravel-openapi-testing instead

This packages is based on osteel/openapi-httpfoundation-testing and provides ValidatesAgainstOpenApiSpec trait

Installation

You can install the package via composer:

composer require greensight/laravel-openapi-testing

Basic usage

Let's add validation according to oas3 to our tests. All we need is to use ValidatesAgainstOpenApiSpec; and implement getOpenApiDocumentPath(): string method like that:

The trait overrides $this->call method to add the needed validation As a result all http related helper methods ($this->get(), $this->postJson() and e.t.c) perform the validation too. Both request and response is validated to match some part of the given spec. If validation fails your tests is automatically marked as failed, no need to need any manual assertions.

Turning validation off

In some cases you may want to turn validation for a specific request. Here is an exanple how to do it:

Mapping paths

In order to validate request against oas3 the package need to map it to one of the paths described in specification document. We use path from Laravel's route ($request->route()->uri) for that purpose. If it does not fully match in your case you can explicitly set OpenApi path for the current request like that:

Contributing

Please see CONTRIBUTING for details.

Testing

  1. composer install
  2. npm i
  3. composer test

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

License

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

All versions of laravel-openapi-testing with dependencies

PHP Build Version
Package Version
Requires php Version ^8.0
osteel/openapi-httpfoundation-testing Version ^0.6.0
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 greensight/laravel-openapi-testing contains the following files

Loading the files please wait ....