Merge pull request #633 from arthvrian/api-routes

API routes

config/config.php

@@ -26,7 +26,8 @@
         'enabled' => false,
         'path' => base_path() . '/vendor/nwidart/laravel-modules/src/Commands/stubs',
         'files' => [
-            'routes' => 'Routes/web.php',
+            'routes/web' => 'Routes/web.php',
+            'routes/api' => 'Routes/api.php',
             'views/index' => 'Resources/views/index.blade.php',
             'views/master' => 'Resources/views/layouts/master.blade.php',
             'scaffold/config' => 'Config/config.php',
@@ -37,7 +38,8 @@
             'package' => 'package.json',
         ],
         'replacements' => [
-            'routes' => ['LOWER_NAME', 'STUDLY_NAME', 'MODULE_NAMESPACE'],
+            'routes/web' => ['LOWER_NAME', 'STUDLY_NAME'],
+            'routes/api' => ['LOWER_NAME'],
             'webpack' => ['LOWER_NAME'],
             'json' => ['LOWER_NAME', 'STUDLY_NAME', 'MODULE_NAMESPACE'],
             'views/index' => ['LOWER_NAME'],

src/Commands/RouteProviderMakeCommand.php

@@ -53,7 +53,8 @@ protected function getTemplateContents()
             'CLASS'            => $this->getFileName(),
             'MODULE_NAMESPACE' => $this->laravel['modules']->config('namespace'),
             'MODULE'           => $this->getModuleName(),
-            'ROUTES_PATH'      => $this->getRoutesPath(),
+            'WEB_ROUTES_PATH'  => $this->getWebRoutesPath(),
+            'API_ROUTES_PATH'  => $this->getApiRoutesPath(),
             'LOWER_NAME'       => $module->getLowerName(),
         ]))->render();
     }
@@ -83,11 +84,19 @@ protected function getDestinationFilePath()
     /**
      * @return mixed
      */
-    protected function getRoutesPath()
+    protected function getWebRoutesPath()
     {
         return '/' . $this->laravel['config']->get('stubs.files.routes', 'Routes/web.php');
     }
 
+    /**
+     * @return mixed
+     */
+    protected function getApiRoutesPath()
+    {
+        return '/' . $this->laravel['config']->get('stubs.files.routes', 'Routes/api.php');
+    }
+
     public function getDefaultNamespace() : string
     {
         return $this->laravel['modules']->config('paths.generator.provider.path', 'Providers');

src/Commands/stubs/route-provider.stub

@@ -7,6 +7,13 @@ use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvi
 
 class $CLASS$ extends ServiceProvider
 {
+    /**
+     * The root namespace to assume when generating URLs to actions.
+     *
+     * @var string
+     */
+    protected $namespace = '$MODULE_NAMESPACE$\$MODULE$\Http\Controllers';
+
     /**
      * Called before routes are registered.
      *
@@ -16,6 +23,18 @@ class $CLASS$ extends ServiceProvider
      */
     public function boot()
     {
+        parent::boot();
+    }
+
+    /**
+     * Define the routes for the application.
+     *
+     * @return void
+     */
+    public function map()
+    {
+        $this->mapApiRoutes();
+
         $this->mapWebRoutes();
     }
 
@@ -28,9 +47,23 @@ class $CLASS$ extends ServiceProvider
      */
     protected function mapWebRoutes()
     {
-        Route::prefix('$LOWER_NAME$')
-            ->middleware('web')
-            ->namespace('$MODULE_NAMESPACE$\$MODULE$\Http\Controllers')
+        Route::middleware('web')
+            ->namespace($this->namespace)
             ->group(__DIR__ . '/../Routes/web.php');
     }
+
+    /**
+     * Define the "api" routes for the application.
+     *
+     * These routes are typically stateless.
+     *
+     * @return void
+     */
+    protected function mapApiRoutes()
+    {
+        Route::prefix('api')
+            ->middleware('api')
+            ->namespace($this->namespace)
+            ->group(__DIR__ . '/../Routes/api.php');
+    }
 }

src/Commands/stubs/routes/api.stub

@@ -0,0 +1,18 @@
+<?php
+
+use Illuminate\Http\Request;
+
+/*
+|--------------------------------------------------------------------------
+| API Routes
+|--------------------------------------------------------------------------
+|
+| Here is where you can register API routes for your application. These
+| routes are loaded by the RouteServiceProvider within a group which
+| is assigned the "api" middleware group. Enjoy building your API!
+|
+*/
+
+Route::middleware('auth:api')->get('/$LOWER_NAME$', function (Request $request) {
+    return $request->user();
+});

src/Commands/stubs/routes/web.stub

@@ -0,0 +1,16 @@
+<?php
+
+/*
+|--------------------------------------------------------------------------
+| Web Routes
+|--------------------------------------------------------------------------
+|
+| Here is where you can register web routes for your application. These
+| routes are loaded by the RouteServiceProvider within a group which
+| contains the "web" middleware group. Now create something great!
+|
+*/
+
+Route::prefix('$LOWER_NAME$')->group(function() {
+    Route::get('/', '$STUDLY_NAME$Controller@index');
+});

tests/Commands/ModuleMakeCommandTest.php

@@ -68,11 +68,23 @@ public function it_generates_module_files()
     }
 
     /** @test */
-    public function it_generates_route_file()
+    public function it_generates_web_route_file()
     {
+        $files = $this->app['modules']->config('stubs.files');
         $this->artisan('module:make', ['name' => ['Blog']]);
 
-        $path = $this->modulePath . '/' . $this->app['modules']->config('stubs.files.routes');
+        $path = $this->modulePath . '/' . $files['routes/web'];
+
+        $this->assertMatchesSnapshot($this->finder->get($path));
+    }
+
+    /** @test */
+    public function it_generates_api_route_file()
+    {
+        $files = $this->app['modules']->config('stubs.files');
+        $this->artisan('module:make', ['name' => ['Blog']]);
+
+        $path = $this->modulePath . '/' . $files['routes/api'];
 
         $this->assertMatchesSnapshot($this->finder->get($path));
     }

tests/Commands/__snapshots__/ModuleMakeCommandTest__it_generates_api_route_file__1.php

@@ -0,0 +1,18 @@
+<?php return '<?php
+
+use Illuminate\\Http\\Request;
+
+/*
+|--------------------------------------------------------------------------
+| API Routes
+|--------------------------------------------------------------------------
+|
+| Here is where you can register API routes for your application. These
+| routes are loaded by the RouteServiceProvider within a group which
+| is assigned the "api" middleware group. Enjoy building your API!
+|
+*/
+
+Route::middleware(\'auth:api\')->get(\'/blog\', function (Request $request) {
+    return $request->user();
+});';

tests/Commands/__snapshots__/ModuleMakeCommandTest__it_generates_module_resources__4.php

@@ -2,11 +2,18 @@
 
 namespace Modules\\Blog\\Providers;
 
-use Illuminate\\Support\\Facades\Route;
+use Illuminate\\Support\\Facades\\Route;
 use Illuminate\\Foundation\\Support\\Providers\\RouteServiceProvider as ServiceProvider;
 
 class RouteServiceProvider extends ServiceProvider
 {
+    /**
+     * The root namespace to assume when generating URLs to actions.
+     *
+     * @var string
+     */
+    protected $namespace = \'Modules\\Blog\\Http\\Controllers\';
+
     /**
      * Called before routes are registered.
      *
@@ -16,6 +23,18 @@ class RouteServiceProvider extends ServiceProvider
      */
     public function boot()
     {
+        parent::boot();
+    }
+
+    /**
+     * Define the routes for the application.
+     *
+     * @return void
+     */
+    public function map()
+    {
+        $this->mapApiRoutes();
+
         $this->mapWebRoutes();
     }
 
@@ -28,10 +47,24 @@ public function boot()
      */
     protected function mapWebRoutes()
     {
-        Route::prefix(\'blog\')
-            ->middleware(\'web\')
-            ->namespace(\'Modules\\Blog\\Http\\Controllers\')
+        Route::middleware(\'web\')
+            ->namespace($this->namespace)
             ->group(__DIR__ . \'/../Routes/web.php\');
     }
+
+    /**
+     * Define the "api" routes for the application.
+     *
+     * These routes are typically stateless.
+     *
+     * @return void
+     */
+    protected function mapApiRoutes()
+    {
+        Route::prefix(\'api\')
+            ->middleware(\'api\')
+            ->namespace($this->namespace)
+            ->group(__DIR__ . \'/../Routes/api.php\');
+    }
 }
-';
+';

tests/Commands/__snapshots__/ModuleMakeCommandTest__it_generates_web_route_file__1.php

@@ -0,0 +1,17 @@
+<?php return '<?php
+
+/*
+|--------------------------------------------------------------------------
+| Web Routes
+|--------------------------------------------------------------------------
+|
+| Here is where you can register web routes for your application. These
+| routes are loaded by the RouteServiceProvider within a group which
+| contains the "web" middleware group. Now create something great!
+|
+*/
+
+Route::prefix(\'blog\')->group(function() {
+    Route::get(\'/\', \'BlogController@index\');
+});
+';

tests/Commands/__snapshots__/RouteProviderMakeCommandTest__it_can_change_the_default_namespace__1.php

@@ -7,6 +7,13 @@
 
 class RouteServiceProvider extends ServiceProvider
 {
+    /**
+     * The root namespace to assume when generating URLs to actions.
+     *
+     * @var string
+     */
+    protected $namespace = \'Modules\\Blog\\Http\\Controllers\';
+
     /**
      * Called before routes are registered.
      *
@@ -16,6 +23,18 @@ class RouteServiceProvider extends ServiceProvider
      */
     public function boot()
     {
+        parent::boot();
+    }
+
+    /**
+     * Define the routes for the application.
+     *
+     * @return void
+     */
+    public function map()
+    {
+        $this->mapApiRoutes();
+
         $this->mapWebRoutes();
     }
 
@@ -28,10 +47,24 @@ public function boot()
      */
     protected function mapWebRoutes()
     {
-        Route::prefix(\'blog\')
-            ->middleware(\'web\')
-            ->namespace(\'Modules\\Blog\\Http\\Controllers\')
+        Route::middleware(\'web\')
+            ->namespace($this->namespace)
             ->group(__DIR__ . \'/../Routes/web.php\');
     }
+
+    /**
+     * Define the "api" routes for the application.
+     *
+     * These routes are typically stateless.
+     *
+     * @return void
+     */
+    protected function mapApiRoutes()
+    {
+        Route::prefix(\'api\')
+            ->middleware(\'api\')
+            ->namespace($this->namespace)
+            ->group(__DIR__ . \'/../Routes/api.php\');
+    }
 }
 ';