goez/apib-unit

Unit Test Helper for API-Blueprint

2.0.0 2022-06-07 10:16 UTC

Requires

• php: ^8.0
• goez/drafter-php: ^7.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.4
• mockery/mockery: ^1.0
• php-parallel-lint/php-parallel-lint: ^1.2
• phpunit/phpunit: ^9.0
• roave/security-advisories: dev-master
• sempro/phpunit-pretty-print: ^1.2

MIT

• jaceju

README

Installation

• Install Drafter.
• Add package to composer:

$ composer require goez/apib-unit --dev

Usage

// Parse API-Blueprint document, and get the endpoints.
$endpoints = (new Apib('./example.apib'))->getEndpoints();

// Get first endpoints
$endpoint = $endpoints[0];

// Get first example of the endpoint
$example = $endpoint->getExamples()[0];

// Get request of example
$request = $example->getRequests()[0];

// Get response of example
$response = $example->getResponse()[0];

// Get JSON Schema of response
$schema = $response->getSchema();

License

MIT