Initial Commit

Author: jsphpl

LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sehr gute GmbH
+
+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.

README.md

@@ -0,0 +1,60 @@
+# laravel5-api
+
+A modular controller for exposing your Laravel 5 Eloquent models as a REST API. All you need to do is to create one subclass of the controller per model and set up the routes.
+
+## Usage
+
+Subclass `SehrGut\Laravel5_Api\Controller` and set the eloquent model your controller should expose. Example:
+
+```php
+use SehrGut\Laravel5_Api\Controller as ApiController;
+use App\Models\Post;
+
+class PostsController extends ApiController
+{
+    protected $model = Post::class;
+}
+```
+
+You now have a controller with the same handlers as a [Laravel Resource Controller](https://laravel.com/docs/5.2/controllers#restful-resource-controllers):
+
+Those methods can now be used to create the following routes:
+
+```php
+Route::get('/posts', 'PostsController@index');
+Route::post('/posts', 'PostsController@store');
+Route::get('/posts/{post_id}', 'PostsController@show');
+Route::put('/posts/{post_id}', 'PostsController@update');
+Route::delete('/posts/{post_id}', 'PostsController@destroy');
+```
+
+## Components
+
+### Controller
+
+#### Handlers
+
+- `index()` - Fetch all resources
+- `store()` - Create a new resource
+- `show()` - Fetch a single resource
+- `update()` - Update a single resource
+- `destroy()` - Delete a single resource
+
+### RequestAdapter
+### Formatter
+### Validator
+### Transformer
+### ModelMapping
+
+## Customization
+
+### Authorization
+
+## Compatibility
+
+* Tested with Laravel 5.2
+* Works with PHP 5.4 upwards
+
+## License
+
+This software is licensed under the [MIT License](https://opensource.org/licenses/MIT). See [LICENSE.txt](LICENSE.txt) for details.

composer.json

@@ -0,0 +1,24 @@
+{
+    "name": "sehrgut/laravel5-api",
+    "description": "A modular controller for exposing your Laravel 5 Eloquent models as a REST API.",
+    "homepage": "http://github.com/sehrgutesoftware/laravel5-api",
+    "type": "library",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Joseph Paul",
+            "email": "[email protected]"
+        },
+        {
+            "name": "Jalil Wahdatehagh",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "php": ">=5.4",
+        "laravel/framework": "5.*"
+    },
+    "autoload": {
+        "psr-4": {"SehrGut\\Laravel5_Api\\": "src/Laravel5_Api"}
+    }
+}