https://github.com/ovr/swagger-assert-helper
:rainbow: Test your API by Swagger like a god on the :rocket:
https://github.com/ovr/swagger-assert-helper
php swagger swagger-php-asserter swagger-scheme swagger-validator
Last synced: about 1 month ago
JSON representation
:rainbow: Test your API by Swagger like a god on the :rocket:
- Host: GitHub
- URL: https://github.com/ovr/swagger-assert-helper
- Owner: ovr
- License: other
- Created: 2016-06-11T14:40:34.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2019-06-25T18:46:47.000Z (almost 6 years ago)
- Last Synced: 2025-05-07T06:06:06.923Z (about 1 month ago)
- Topics: php, swagger, swagger-php-asserter, swagger-scheme, swagger-validator
- Language: PHP
- Homepage:
- Size: 214 KB
- Stars: 3
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Swagger Assert Helper
=====================
[](https://travis-ci.org/ovr/swagger-assert-helper)
This library bring support for:
- Making HTTP Request by Swagger Path
- Asserting HTTP Response with Swagger Response Scheme
- Functional testing on top of frameworks: `Zend`, `Laravel`, `Slim`, `Symfony`
- Integration testing on top of: `Guzzle`
## Installing via Composer
You can use [Composer](https://getcomposer.org) .
```bash
composer require ovr/swagger-assert-helper
```
# How to use?
# 1. Write Swagger Definition for your API:
I love to use PHP comments, example:
```php
/**
* @SWG\Definition(
* definition = "UserResponse",
* required={"id", "name"},
* @SWG\Property(property="id", type="integer", format="int64"),
* @SWG\Property(property="name", type="string"),
* );
*/
class UserController extends AbstractController
{
/**
* @SWG\Get(
* tags={"User"},
* path="/user/{id}",
* operationId="getUserById",
* summary="Find user by $id",
* @SWG\Parameter(
* name="id",
* description="$id of the specified",
* in="path",
* required=true,
* type="string"
* ),
* @SWG\Response(
* response=200,
* description="success",
* @SWG\Schema(ref="#/definitions/UserResponse")
* ),
* @SWG\Response(
* response=404,
* description="Not found"
* )
* )
*/
public function getAction() {}
}
```
More definition examples you can find in:
- [Example/API](examples/api) - example of small HTTP REST service by PHP comments
- [Example/GitHub](examples/github) - example definitions for `api.github.com` by PHP comments
# 2. Write test for your Controller
## Functional
Functional - when you execute `Request` inside your service (`PHP` code), there are support for:
- Symfony by [SymfonyTrait](src/SymfonyTrait.php)
- Laravel by [LaravelTrait](src/LaravelTrait.php)
- Zend by [ZendTrait](src/ZendTrait.php)
- Slim by [SlimTrait](src/SlimTrait)
Example:
```php
class UserControllerTest extends \PHPUnit\Framework\TestCase
{
// You should use trait for your framework, review supported and use what you need
use \Ovr\Swagger\SymfonyTrait;
public function testGetUserById()
{
// We define operation called getUserById in first step!
$operation = $this->getSwaggerWrapper()->getOperationByName('getUserById');
// Call makeRequestByOperation from our framework Trait, SymfonyTrait for us
$request = $this->makeRequestByOperation(
$operation,
[
'id' => 1
]
);
// This will be \Symfony\Component\HttpFoundation\Request
var_dump($request);
// You should execute your API module by Request and get Response
$response = $this->getApi()->handle($request);
$this->getSwaggerWrapper()->assertHttpResponseForOperation(
// Call makeRequestByOperation from our framework Trait, SymfonyTrait for us
$this->extractResponseData($response),
// getUserById
$operation,
// Operation can response by codes that your defined, lets assert that it will be 200 (HTTP_OK)
Response::HTTP_OK
);
}
/**
* Return API module/service/bundle, that handle request and return Response for it
*/
abstract public function getApi();
/**
* SwaggerWrapper store all information about API and help us with assertHttpResponseForOperation
*
* @return \Ovr\Swagger\SwaggerWrapper
*/
protected function getSwaggerWrapper()
{
return new \Ovr\Swagger\SwaggerWrapper(
\Swagger\scan(
// Path to your API
__DIR__ . '/../../examples/api'
)
);
}
}
```
## Integration
Integration - when you execute `Request` by real transport, there are support for:
- Guzzle by [GuzzleTrait](src/GuzzleTrait.php)
# FAQ
- Q: Can this library validate my Swagger definition?
- A: No. This library validate your API requests and responses match your Swagger definition.
- Q: What content types are supported?
- A: JSON for now, ask me for XML or something else in the issues.
# LICENSE
This project is open-sourced software licensed under the MIT License.
See the [LICENSE](LICENSE) file for more information.