Download the PHP package goez/open-api-tester without Composer
On this page you can find all versions of the php package goez/open-api-tester. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
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.
Informations about the package open-api-tester
Open API Tester
Test API output format using Open API Spec 3 document.
Branches
1.x: Supports PHP 7.2.2.x: Supports PHP 7.4 and above.
Installation
Install this package into your project:
Generate an API documentation example and a PHPUnit test case in your Laravel project:
The command will generate the following files:
docs/api/*: The API documentation example.tests/Feature/OpenApiSchemaTest.php: The PHPUnit test case.
Basic Usage
Define a Test Case
In the operation level of the document, add an x-api-tests extended field. Inside it, list one or more test cases in an array format.
The format of a test case is as follows:
Retrieving Test Cases
Using Laravel/Lumen with PHPUnit
Define a PHPUnit Test Case
You can refer this file tests/Feature/OpenApiSchemaTest.php.
Organizing the Request Format
Laravel doesn't actually send out HTTP requests, but instead creates a Request object and feeds it directly to the Laravel app for processing.
So, it's important to note the following:
- The request content doesn't need to be compiled into the actual format (JSON, urlencoded, etc); it can be directly inserted into the
$parametersparameter in the form of a PHP array. - For file uploads, use the
Illuminate\Http\UploadedFileobject. Both the$parametersand$filesfields should contain a copy. - You can use the
transformHeadersToServerVarsmethod built into Laravel TestCase to convert the header part of the request into the$servervariable. In this example, we convert the test request into a format that Laravel can easily digest:
