Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
mpociot committed May 3, 2016
0 parents commit 0e25996
Show file tree
Hide file tree
Showing 7 changed files with 615 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.DS_Store
composer.lock
.php_cs.cache
/vendor/
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2016 Marcel Pociot

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
## Laravel API Documentation Generator (WIP)

`php artisan api:gen --routePrefix=settings/api/*`


### Install

Require this package with composer using the following command:

```bash
composer require mpociot/laravel-apidoc-generator
```
Go to your `config/app.php` and add the service provider:

```php
Mpociot\ApiDoc\ApiDocGeneratorServiceProvider::class
```

### Usage


```
php artisan api:generate
{--output=public/docs : The output path for the generated documentation}
{--routePrefix= : The route prefix to use for generation - * can be used as a wildcard}
{--routes=* : The route names to use for generation - if no routePrefix is provided}
{--actAsUserId= : The user ID to use for API response calls}
```


### License

The Laravel API Documentation Generator is free software licensed under the MIT license.
25 changes: 25 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"name": "mpociot/laravel-apidoc-generator",
"license": "MIT",
"description": "Generate beautiful API documentation from your Laravel / Lumen application",
"keywords": ["API","Documentation","Laravel"],
"homepage": "http://github.com/mpociot/apidoc",
"authors": [
{
"name": "Marcel Pociot",
"email": "[email protected]"
}
],
"require": {
"php": ">=7.0.0",
"laravel/framework": "~5.0",
"phpdocumentor/reflection-docblock": "~2.0"
},
"require-dev": {
},
"autoload": {
"psr-0": {
"Mpociot\\ApiDoc": "src/"
}
}
}
35 changes: 35 additions & 0 deletions src/Mpociot/ApiDoc/ApiDocGeneratorServiceProvider.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<?php

namespace Mpociot\ApiDoc;

use Illuminate\Support\ServiceProvider;
use Mpociot\ApiDoc\Commands\GenerateDocumentation;

class ApiDocGeneratorServiceProvider extends ServiceProvider
{

/**
* Bootstrap the application events.
*
* @return void
*/
public function boot()
{
$this->loadViewsFrom(__DIR__.'/../../resources/views/', 'apidoc');
}

/**
* Register the API doc commands
*/
public function register()
{
$this->app['apidoc.generate'] = $this->app->share(function () {
return new GenerateDocumentation();
});

$this->commands(
'apidoc.generate'
);
}

}
Loading

0 comments on commit 0e25996

Please sign in to comment.