-
Notifications
You must be signed in to change notification settings - Fork 611
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 0e25996
Showing
7 changed files
with
615 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
.DS_Store | ||
composer.lock | ||
.php_cs.cache | ||
/vendor/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/" | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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' | ||
); | ||
} | ||
|
||
} |
Oops, something went wrong.