https://github.com/etiennemarais/outline-laravel

A laravel/lumen service provider wrapper for the Outline api blueprint test generator
https://github.com/etiennemarais/outline-laravel

Last synced: about 5 hours ago
JSON representation

A laravel/lumen service provider wrapper for the Outline api blueprint test generator

• Host: GitHub
• URL: https://github.com/etiennemarais/outline-laravel
• Owner: etiennemarais
• License: gpl-3.0
• Created: 2016-01-18T08:47:26.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-02-04T19:14:07.000Z (almost 9 years ago)
• Last Synced: 2024-04-02T14:21:35.264Z (8 months ago)
• Language: PHP
• Size: 17.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# outline-laravel

Parse and generate API Blueprint markdown into Feature/Acceptance tests wrapper for laravel/lumen to use in your apps.

## 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

Add the Service provider to your app. If you are using laravel, add this line in your `config/app.php`:

```

\OutlineLaravel\OutlineLaravelServiceProvider::class

```

If you are using lumen, add this line in your `bootstrap/app.php`:

```

 $app->register(\OutlineLaravel\OutlineLaravelServiceProvider::class);

```

You will be able to run the command in your command prompt. 

```

php artisan outline:regenerate

```

NOTE: This assumes that you have connected your apiary document to your github account, or have a `.apib` file in your project root. You can check out 

 [Apiary here](https://apiary.io/). It is a really good tool to quickly spec API endpoints in a standardised format.