Merge remote-tracking branch 'origin/master'

README.md

@@ -2,7 +2,7 @@
 
 Automatically generate your API documentation from your existing Laravel routes. Take a look at the [example documentation](http://marcelpociot.de/whiteboard/).
 
-`php artisan api:gen --routePrefix="settings/api/*"`
+`php artisan apidoc:gen --routePrefix="settings/api/*"`
 
 [![Latest Stable Version](https://poser.pugx.org/mpociot/laravel-apidoc-generator/v/stable)](https://packagist.org/packages/mpociot/laravel-apidoc-generator)[![Total Downloads](https://poser.pugx.org/mpociot/laravel-apidoc-generator/downloads)](https://packagist.org/packages/mpociot/laravel-apidoc-generator)
 [![License](https://poser.pugx.org/mpociot/laravel-apidoc-generator/license)](https://packagist.org/packages/mpociot/laravel-apidoc-generator)
@@ -29,16 +29,16 @@ Mpociot\ApiDoc\ApiDocGeneratorServiceProvider::class,
 
 ## Usage
 
-To generate your API documentation, use the `api:generate` artisan command.
+To generate your API documentation, use the `apidoc:generate` artisan command.
 
 ```sh
-$ php artisan api:generate --routePrefix="api/v1/*"
+$ php artisan apidoc:generate --routePrefix="api/v1/*"
 
 ```
 You can pass in multiple prefixes by spearating each prefix with comma.
 
 ```sh
-$ php artisan api:generate --routePrefix="api/v1/*,api/public/*"
+$ php artisan apidoc:generate --routePrefix="api/v1/*,api/public/*"
 ```
 It will generate documentation for all of the routes whose prefixes are `api/v1/` and `api/public/`
 
@@ -201,13 +201,13 @@ If your API route accepts a `GET` method, this package tries to call the API rou
 If your API needs an authenticated user, you can use the `actAsUserId` option to specify a user ID that will be used for making these API calls:
 
 ```sh
-$ php artisan api:generate --routePrefix="api/*" --actAsUserId=1
+$ php artisan apidoc:generate --routePrefix="api/*" --actAsUserId=1
 ```
 
 If you don't want to automatically perform API response calls, use the `noResponseCalls` option.
 
 ```sh
-$ php artisan api:generate --routePrefix="api/*" --noResponseCalls
+$ php artisan apidoc:generate --routePrefix="api/*" --noResponseCalls
 ```
 
 > Note: The example API responses work best with seeded data.
@@ -235,10 +235,10 @@ APP_URL=http://yourapp.app
 If you want to modify the content of your generated documentation, go ahead and edit the generated `index.md` file.
 The default location of this file is: `public/docs/source/index.md`.
  
-After editing the markdown file, use the `api:update` command to rebuild your documentation as a static HTML file.
+After editing the markdown file, use the `apidoc:update` command to rebuild your documentation as a static HTML file.
 
 ```sh
-$ php artisan api:update
+$ php artisan apidoc:update
 ```
 
 As an optional parameter, you can use `--location` to tell the update command where your documentation can be found.

src/Commands/GenerateDocumentation.php

@@ -21,7 +21,7 @@ class GenerateDocumentation extends Command
      *
      * @var string
      */
-    protected $signature = 'api:generate
+    protected $signature = 'apidoc:generate
                             {--output=public/docs : The output path for the generated documentation}
                             {--routeDomain= : The route domain (or domains) to use for generation}
                             {--routePrefix= : The route prefix (or prefixes) to use for generation}

src/Commands/UpdateDocumentation.php

@@ -12,7 +12,7 @@ class UpdateDocumentation extends Command
      *
      * @var string
      */
-    protected $signature = 'api:update 
+    protected $signature = 'apidoc:update
                             {--location=public/docs : The documentation location}
     ';
 

tests/GenerateDocumentationTest.php

@@ -64,7 +64,7 @@ class GenerateDocumentationTest extends TestCase
 
     public function testConsoleCommandNeedsPrefixesOrDomainsOrRoutes()
     {
-        $output = $this->artisan('api:generate');
+        $output = $this->artisan('apidoc:generate');
         $this->assertEquals('You must provide either a route prefix, a route domain, a route or a middleware to generate the documentation.'.PHP_EOL, $output);
     }
 
@@ -75,7 +75,7 @@ class GenerateDocumentationTest extends TestCase
         });
         RouteFacade::get('/api/test', TestController::class.'@parseMethodDescription');
 
-        $output = $this->artisan('api:generate', [
+        $output = $this->artisan('apidoc:generate', [
             '--routePrefix' => 'api/*',
         ]);
         $this->assertContains('Skipping route: [GET] api/closure', $output);
@@ -91,7 +91,7 @@ class GenerateDocumentationTest extends TestCase
             });
             $api->get('v1/test', DingoTestController::class.'@parseMethodDescription');
 
-            $output = $this->artisan('api:generate', [
+            $output = $this->artisan('apidoc:generate', [
                 '--router' => 'dingo',
                 '--routePrefix' => 'v1/*',
             ]);
@@ -105,7 +105,7 @@ class GenerateDocumentationTest extends TestCase
         RouteFacade::get('/api/skip', TestController::class.'@skip');
         RouteFacade::get('/api/test', TestController::class.'@parseMethodDescription');
 
-        $output = $this->artisan('api:generate', [
+        $output = $this->artisan('apidoc:generate', [
             '--routePrefix' => 'api/*',
         ]);
         $this->assertContains('Skipping route: [GET] api/skip', $output);
@@ -115,7 +115,7 @@ class GenerateDocumentationTest extends TestCase
     public function testCanParseResourceRoutes()
     {
         RouteFacade::resource('/api/user', TestResourceController::class);
-        $output = $this->artisan('api:generate', [
+        $output = $this->artisan('apidoc:generate', [
             '--routePrefix' => 'api/*',
         ]);
         $fixtureMarkdown = __DIR__.'/Fixtures/resource_index.md';
@@ -130,7 +130,7 @@ class GenerateDocumentationTest extends TestCase
                 'index', 'create',
             ],
         ]);
-        $output = $this->artisan('api:generate', [
+        $output = $this->artisan('apidoc:generate', [
             '--routePrefix' => 'api/*',
         ]);
         $fixtureMarkdown = __DIR__.'/Fixtures/partial_resource_index.md';
@@ -142,7 +142,7 @@ class GenerateDocumentationTest extends TestCase
                 'index', 'create',
             ],
         ]);
-        $output = $this->artisan('api:generate', [
+        $output = $this->artisan('apidoc:generate', [
             '--routePrefix' => 'api/*',
         ]);
         $fixtureMarkdown = __DIR__.'/Fixtures/partial_resource_index.md';
@@ -155,7 +155,7 @@ class GenerateDocumentationTest extends TestCase
         RouteFacade::get('/api/test', TestController::class.'@parseMethodDescription');
         RouteFacade::get('/api/fetch', TestController::class.'@fetchRouteResponse');
 
-        $output = $this->artisan('api:generate', [
+        $output = $this->artisan('apidoc:generate', [
             '--routePrefix' => 'api/*',
         ]);
 
@@ -171,7 +171,7 @@ class GenerateDocumentationTest extends TestCase
         RouteFacade::get('/api/test', TestController::class.'@parseMethodDescription');
         RouteFacade::get('/api/fetch', TestController::class.'@fetchRouteResponse');
 
-        $this->artisan('api:generate', [
+        $this->artisan('apidoc:generate', [
             '--routePrefix' => 'api/*',
         ]);
 
@@ -180,7 +180,7 @@ class GenerateDocumentationTest extends TestCase
         copy($prependMarkdown, __DIR__.'/../public/docs/source/prepend.md');
         copy($appendMarkdown, __DIR__.'/../public/docs/source/append.md');
 
-        $this->artisan('api:generate', [
+        $this->artisan('apidoc:generate', [
             '--routePrefix' => 'api/*',
         ]);
 
@@ -193,7 +193,7 @@ class GenerateDocumentationTest extends TestCase
     {
         RouteFacade::get('/api/test/{foo}', TestController::class.'@addRouteBindingsToRequestClass');
 
-        $this->artisan('api:generate', [
+        $this->artisan('apidoc:generate', [
             '--routePrefix' => 'api/*',
             '--bindings' => 'foo,bar',
         ]);
@@ -208,7 +208,7 @@ class GenerateDocumentationTest extends TestCase
         RouteFacade::get('/api/test', TestController::class.'@parseMethodDescription');
         RouteFacade::post('/api/fetch', TestController::class.'@fetchRouteResponse');
 
-        $output = $this->artisan('api:generate', [
+        $output = $this->artisan('apidoc:generate', [
             '--routePrefix' => 'api/*',
         ]);
 
@@ -223,7 +223,7 @@ class GenerateDocumentationTest extends TestCase
     {
         RouteFacade::get('/api/headers', TestController::class.'@checkCustomHeaders');
 
-        $output = $this->artisan('api:generate', [
+        $output = $this->artisan('apidoc:generate', [
             '--routePrefix' => 'api/*',
             '--header' => [
                 'Authorization: customAuthToken',
@@ -244,7 +244,7 @@ class GenerateDocumentationTest extends TestCase
     {
         RouteFacade::get('/api/utf8', TestController::class.'@utf8');
 
-        $output = $this->artisan('api:generate', [
+        $output = $this->artisan('apidoc:generate', [
             '--routePrefix' => 'api/*',
         ]);