如何在Laravel中创建REST API第一个Web应用程序

Question

我想在Laravel中制作一个API第一应用程序。我不知道什么是最好的方法来做到这一点，我会解释我正在努力做什么，但请随意给出答案如何以不同的方式做到这一点。

我不希望我所有的前端都是用javascript编写的，并用angular.js或类似的东西解析API的JSON输出。我希望我的Laravel应用程序产生超文本标记语言视图。我试图走下去的道路上有两个控制器一个对API和一个对网络。对于显示用户操作，我的routes.php如下所示：

# the web controller
Route::controller('user', 'WebUserController');

# the api controller 
Route::group(array('prefix' => 'api'), function() {
    Route::resource('user', 'UserController');
});

所以/user会带我去WebUserController和/api/user会带我去UserController。现在我想把我所有的逻辑放在APIUserController中，并从WebUserController中调用它的操作。这是他们两个的代码：

class UserController extends BaseController 
{
    public function show($id)
    {
        $user = User::find($id);
        return Response::json(array('success'=>true,'user'=>$user->toArray()));
    }
}

class WebUserController extends UserController 
{
    public function getView($id) 
    {
         # call the show method of the API's User Controller
         $response =  $this->show($id);
         return View::make('user.view')->with('data', $response->getData());
    }
}

在WebUserController中，我能够使用getData（）获取响应的json内容，但我无法获取标头和状态代码（它们是Illumate\Http\JsonResents的受保护属性）。

我认为我的方法可能不是最好的，所以我愿意接受如何制作这个应用程序的建议。

编辑：Drew Lewis已经回答了如何获得响应的标题和状态的问题，但我仍然认为可能有更好的方法来设计这个

Answer 1

检查Laravel的RESTful控制器：

http://laravel.com/docs/controllers#restful-控制器

他们的医生做得很好。

但更好的是这个教程：

http://code.tutsplus.com/tutorials/laravel-4-a-start-at-a-restful-api-updated--net-29785

Answer 2

您应该为此设计使用存储库。

例子-

//UserRepository Class
class UserRepository {
    public function getById($id)
    {
      return User::find($id);
    }
}

// WebUser Controller
class WebUserController extends BaseController {
    protected $user;

    public function __construct(UserRepository $user)
    {
        $this->user = $user;
    }

    public function show($id)
    {
        return View::make('user.view')->with('data', $this->user->getById($id));
    }
}

// APIUser Controller
class UserController extends BaseController {
    protected $user;

    public function __construct(UserRepository $user)
    {
        $this->user = $user;
    }

    public function show($id)
    {
        $data =>$this->user->getById($id);
        return Response::json(array('success'=>true,'user'= $data->toArray()));
    }
}

Answer 3

您应该使用存储库/网关设计模式：请在此处查看答案。

例如，在处理用户模型时，首先创建一个用户存储库。用户存储库的唯一职责是与数据库通信（执行CRUD操作）。此用户存储库扩展了公共基础存储库，并实现了一个包含所有所需方法的界面：

class EloquentUserRepository extends BaseRepository implements UserRepository
{
    public function __construct(User $user) {
        $this->user = $user;
    }


    public function all() {
        return $this->user->all();
    }

    public function get($id){}

    public function create(array $data){}

    public function update(array $data){}

    public function delete($id){}

    // Any other methods you need go here (getRecent, deleteWhere, etc)

}

然后，创建一个服务提供者，它将您的用户存储库接口绑定到您雄辩的用户存储库。只要您需要用户存储库（通过IoC容器解析它或在构造函数中注入依赖项），Laravel就会自动为您提供刚刚创建的雄辩用户存储库的实例。这样，如果您将ORM更改为Elount以外的内容，您只需更改此服务提供商，无需对代码库进行其他更改：

use Illuminate\Support\ServiceProvider;

class RepositoryServiceProvider extends ServiceProvider {

    public function register() {
        $this->app->bind(
            'lib\Repositories\UserRepository',        // Assuming you used these
            'lib\Repositories\EloquentUserRepository' // namespaces
        );
    }

}

接下来，创建一个用户网关，其目的是与任意数量的存储库进行对话，并执行应用程序的任何业务逻辑：

use lib\Repositories\UserRepository;

class UserGateway {

    protected $userRepository;

    public function __construct(UserRepository $userRepository) {
        $this->userRepository = $userRepository;
    }

        public function createUser(array $input)
        {
            // perform any sort of validation first
            return $this->userRepository->create($input);
        }

}

最后，创建您的用户web控制器。此控制器与您的用户网关对话：

class UserController extends BaseController 
{
    public function __construct(UserGatway $userGateway)
    {
        $this->userGateway = $userGateway;
    }

    public function create()
    {
        $user = $this->userGateway->createUser(Input::all());

    }
}

通过以这种方式构建应用程序的设计，您可以获得几个好处：您可以实现非常清晰的关注点分离，因为您的应用程序将遵循单一责任原则（通过将业务逻辑与数据库逻辑分离）。这使您能够以更简单的方式执行单元和集成测试，使控制器尽可能纤薄，并允许您在将来根据需要轻松地将Elount替换为任何其他数据库。

例如，如果从Eloquent更改为Mongo，则只需要更改服务提供者绑定以及创建实现UserRepository接口的MongouseRepository。这是因为存储库是唯一与数据库通信的东西——它不知道其他任何东西。因此，新的MongouseRepository可能看起来像：

class MongoUserRepository extends BaseRepository implements UserRepository
{
    public function __construct(MongoUser $user) {
        $this->user = $user;
    }


    public function all() {
        // Retrieve all users from the mongo db
    }

    ...

}

服务提供商现在将UserRepository接口绑定到新的MongoUserRepository：

 $this->app->bind(
        'lib\Repositories\UserRepository',       
        'lib\Repositories\MongoUserRepository'
);

在您的所有网关中，您一直在引用UserRepository，因此通过进行此更改，您实际上是在告诉Laravel使用新的MongoUserRepository，而不是旧的雄辩库。不需要其他更改。