好的,我有以下情况:
我正在构建的系统是从REST API中检索数据并将该数据保存到数据库中。我想知道的是如何实现这一点以及这样的行为在Laravels结构(控制器,模型等)意义上的位置? Laravel是否有内置机制从外部源检索数据?
答案 0 :(得分:42)
修改强> Buzz已更新超过一年,建议现在使用Guzzle,请参阅Mohammed Safeer's回答。
我使用Buzz package来发出API请求。
您可以通过将此包添加到require
文件的composer.json
部分来添加此包。
{
require: {
"kriswallsmith/buzz": "dev-master"
}
}
然后运行composer update
以安装它。
然后在Laravel中,您可以将其包装在一个类(可能是一个类似于存储库的类)中,该类处理发出API请求并返回您的应用程序使用的数据。
<?php namespace My\App\Service;
class SomeApi {
public function __construct($buzz)
{
$this->client = $buzz;
}
public function getAllWidgets()
{
$data = $this->client->get('http://api.example.com/all.json');
// Do things with data, etc etc
}
}
注意:这是伪代码。您需要创建一个适合您需求的类,并执行您想要/需要的任何花哨依赖注入或代码体系结构。
正如@Netbulae所指出的,存储库可能对您有所帮助。 article he linked是一个很好的起点。本文与您的代码之间的唯一区别是,您不是使用Eloquent模型从数据库获取数据,而是发出API请求并将结果转换为应用程序可以使用的一组数组/对象使用(基本上,只是数据存储是不同的,这是首先打扰存储库类的好处之一)。
答案 1 :(得分:24)
我们可以在Laravel中使用包Guzzle,它是一个发送HTTP请求的PHP HTTP客户端。
你可以通过作曲家安装Guzzle
composer require guzzlehttp/guzzle:~6.0
或者您可以将Guzzle指定为项目现有composer.json
中的依赖项{
"require": {
"guzzlehttp/guzzle": "~6.0"
}
}
使用Guzzle的laravel 5中的示例代码,如下所示,
use GuzzleHttp\Client;
class yourController extends Controller {
public function saveApiData()
{
$client = new Client();
$res = $client->request('POST', 'https://url_to_the_api', [
'form_params' => [
'client_id' => 'test_id',
'secret' => 'test_secret',
]
]);
$result= $res->getBody();
dd($result);
}
答案 2 :(得分:8)
首先,您必须在app/routes.php
/*
API Routes
*/
Route::group(array('prefix' => 'api/v1', 'before' => 'auth.basic'), function()
{
Route::resource('pages', 'PagesController', array('only' => array('index', 'store', 'show', 'update', 'destroy')));
Route::resource('users', 'UsersController');
});
注意: 如果您不需要API调用的身份验证,则可以删除'before' => 'auth.basic'
您可以在此处访问index, store, show, update and destroy
。
PagesController
方法
请求网址将是,
GET http://localhost/project/api/v1/pages // this will call index function
POST http://localhost/project/api/v1/pages // this will call store function
GET http://localhost/project/api/v1/pages/1 // this will call show method with 1 as arg
PUT http://localhost/project/api/v1/pages/1 // this will call update with 1 as arg
DELETE http://localhost/project/api/v1/pages/1 // this will call destroy with 1 as arg
命令行CURL请求将是这样的(此处用户名和密码为admin
),并假设您有.htaccess
个文件从网址中删除index.php
,
curl --user admin:admin localhost/project/api/v1/pages
curl --user admin:admin -d 'title=sample&slug=abc' localhost/project/api/v1/pages
curl --user admin:admin localhost/project/api/v1/pages/2
curl -i -X PUT --user admin:admin -d 'title=Updated Title' localhost/project/api/v1/pages/2
curl -i -X DELETE --user admin:admin localhost/project/api/v1/pages/1
接下来,您的PagesController.php
文件夹中有两个名为UsersController.php
和app/controllers
的控制器。
PagesController.php,
<?php
class PagesController extends BaseController {
/**
* Display a listing of the resource.
*
* @return Response
* curl --user admin:admin localhost/project/api/v1/pages
*/
public function index() {
$pages = Page::all();;
return Response::json(array(
'status' => 'success',
'pages' => $pages->toArray()),
200
);
}
/**
* Store a newly created resource in storage.
*
* @return Response
* curl --user admin:admin -d 'title=sample&slug=abc' localhost/project/api/v1/pages
*/
public function store() {
// add some validation also
$input = Input::all();
$page = new Page;
if ( $input['title'] ) {
$page->title =$input['title'];
}
if ( $input['slug'] ) {
$page->slug =$input['slug'];
}
$page->save();
return Response::json(array(
'error' => false,
'pages' => $page->toArray()),
200
);
}
/**
* Display the specified resource.
*
* @param int $id
* @return Response
* curl --user admin:admin localhost/project/api/v1/pages/2
*/
public function show($id) {
$page = Page::where('id', $id)
->take(1)
->get();
return Response::json(array(
'status' => 'success',
'pages' => $page->toArray()),
200
);
}
/**
* Update the specified resource in storage.
*
* @param int $id
* @return Response
* curl -i -X PUT --user admin:admin -d 'title=Updated Title' localhost/project/api/v1/pages/2
*/
public function update($id) {
$input = Input::all();
$page = Page::find($id);
if ( $input['title'] ) {
$page->title =$input['title'];
}
if ( $input['slug'] ) {
$page->slug =$input['slug'];
}
$page->save();
return Response::json(array(
'error' => false,
'message' => 'Page Updated'),
200
);
}
/**
* Remove the specified resource from storage.
*
* @param int $id
* @return Response
* curl -i -X DELETE --user admin:admin localhost/project/api/v1/pages/1
*/
public function destroy($id) {
$page = Page::find($id);
$page->delete();
return Response::json(array(
'error' => false,
'message' => 'Page Deleted'),
200
);
}
}
然后你有一个名为Page
的模型,它将使用名为pages
的表。
<?php
class Page extends Eloquent {
}
您可以使用Laravel4 Generators使用php artisan generator
命令创建这些资源。阅读here。
因此,使用此路由分组,您可以使用相同的应用程序来发出API请求并作为前端。
答案 3 :(得分:5)
您可以选择使用的内容:
file_get_contents:
$json = json_decode(file_get_contents('http://host.com/api/v1/users/1'), true);
答案 4 :(得分:2)
尝试查看外部API的手册。在那里,您将找到有关如何检索信息的信息。
然后最好的计划是建立一个接口。 看一下这个: http://culttt.com/2013/07/08/creating-flexible-controllers-in-laravel-4-using-repositories/
由你来决定如何解决这个问题。