etiennemarais/outline

Parse and generate API Blueprint markdown into Feature/Acceptance tests.

0.2.3 2016-02-04 15:01 UTC

Requires

• php: 5.6.*
• hmaus/drafter-php: 2.*

Requires (Dev)

• fzaninotto/faker: ~1.4
• illuminate/support: ~5.2
• mockery/mockery: 0.9.*
• phpspec/phpspec: ~2.1
• phpunit/phpunit: ~4.0
• symfony/var-dumper: ~3.0

GPL-3.0

• Etienne Marais

• fixtures
• api
• TDD
• blueprint
• specification
• generated docs

README

Parse and generate API Blueprint markdown into Feature/Acceptance tests

NOTE

This project is still very opinionated about how it parses api blueprint documents and is built entirely for a single use case

TODO

• I will continue to build this out over time to accept any format of api blueprint document and generate acceptance tests for them

Example usage

// Get the parser
$drafter = new \DrafterPhp\Drafter(__DIR__ . '/../vendor/bin/drafter');

// Build a new blueprint object
$apiBlueprint = new ApiBlueprint($drafter, __DIR__ . '/example.apib');

// Run the thing
(new Generator(new Transformer))
    ->with($apiBlueprint)
    ->outputTo(__DIR__ . '/generated_tests')
    ->generateTestsFor('lumen'); // Entirely only supports laravel style test output