Download the PHP package saritasa/openapi-httpfoundation-testing without Composer

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

Informations about the package openapi-httpfoundation-testing

OpenAPI HttpFoundation Testing

Build Status Scrutinizer Code Quality

Strengthen your API tests by validating HttpFoundation responses against OpenAPI (3.0.x) definitions.

See this article for more details, and this repository for an example use in a Laravel project.

Why?

OpenAPI is a specification intended to describe RESTful APIs in a way that is understood by humans and machines alike.

By validating an API's responses against the OpenAPI definition that describes it, we guarantee that the API's behaviour conforms to the documentation we provide, thus making the OpenAPI definition the single source of truth.

The HttpFoundation component is developed and maintained as part of the Symfony framework. It is used to handle HTTP requests and responses in projects such as Symfony, Laravel, Drupal, and many other major industry players (see the extended list).

How does it work?

This package is built upon the OpenAPI PSR-7 Message Validator package, which validates PSR-7 messages against OpenAPI definitions.

It essentially converts HttpFoundation response objects to PSR-7 messages using Symfony's PSR-7 Bridge and Tobias Nyholm's PSR-7 implementation, before passing them on to the OpenAPI PSR-7 Message Validator.

Install

Via Composer:

💡 This package is meant to be used for development only, as part of your API test suite.

Usage

First, import the builder in the class that will perform the validation:

Use the builder to create a Osteel\OpenApi\Testing\ResponseValidator object, feeding it a YAML or JSON OpenAPI definition:

💡 Instead of a file, you can also pass a YAML or JSON string directly.

You can now validate a Symfony\Component\HttpFoundation\Response object for a given path and method:

💡 For convenience, responses implementing Psr\Http\Message\ResponseInterface are also accepted.

In the example above, we check that the response matches the OpenAPI definition for a POST request on the /users path.

Each of OpenAPI's supported HTTP methods (GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS and TRACE) also has a shortcut method that calls validate under the hood, meaning the line above could also be written this way:

The validate method returns true in case of success, and throws PSR-7 message-related exceptions from the underlying OpenAPI PSR-7 Message Validator package in case of error.

Change log

Please see the Releases section for more information on what has changed recently.

Testing

Contributing

Please see CODE_OF_CONDUCT for details.

Credits

People

Special thanks to Pavel Batanov for his advice on structuring the package.

Packages

License

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

All versions of openapi-httpfoundation-testing with dependencies

PHP Build Version
Package Version
Requires php Version ^7.2
ext-json Version *
league/openapi-psr7-validator Version ^0.12.1
nyholm/psr7 Version ^1.3
psr/http-message Version ^1.0
symfony/http-foundation Version ^4.4 || ^5.0
symfony/psr-http-message-bridge Version ^2.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 saritasa/openapi-httpfoundation-testing contains the following files

Loading the files please wait ....