Laravel:簡單接口編寫
1.下載搭建Laravel項目
下載laravel項目
//5.7是版本號,可以更換成別的版本,project_name是你創建項目的名稱
composer create-project laravel/laravel=5.7.* --prefer-dist apidemo
新建數據庫
創建一個apidemo數據庫,新建一個book_type表
CREATE TABLE `apidemo`.`book_type` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`type_name` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
`sort` int(11) NULL DEFAULT NULL,
`reamrk` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
PRIMARY KEY (`id`) USING BTREE
) ENGINE = MyISAM AUTO_INCREMENT = 1 CHARACTER SET = utf8 COLLATE = utf8_general_ci ROW_FORMAT = Dynamic;
進行數據庫配置
對.env 文件進行配置
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=apidemo
DB_USERNAME=root
DB_PASSWORD=root
2.新建Model和Controller
php artisan make:model Models/Book_type
php artisan make:cotroller UserController
/**
* 關聯到模型的數據表
* @var string
*/
protected $table = 'book_type';
/**
* Laravel有默認時間字段,如果不需要則去除
* 表明模型是否應該被打上時間戳
* @var bool
*/
public $timestamps = false;
3.創建一個簡單的接口
controller
//根據id查詢圖書類型
public function getType($id)
{
$user = Book_type::find($id);
return response()->json($user);
}
routes/api.php
Route::any('/booktype/{id}', 'BooktypeController@getType');
通過http://xxxxx/api/booktype/1訪問,一定要加上api
//返回值
{
id: 1,
type_name: "測試分類1",
sort: 1,
reamrk: "評論"
}
4.返回值
接口返回json數據
return response()->json($collection);
如果想返回status,msg,data類型的json數據可以通過這種方式
return response()->json(['status'=>1,'msg'=>'查詢成功!','data'=>$collection]);
5.關聯查詢
定義一個圖書表,通過type_id與類型表關聯
CREATE TABLE `apidemo`.`book_detail` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`title` varchar(100) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
`pic` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
`author` varchar(50) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
`ISBN` varchar(20) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
`publish` varchar(50) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
`price` decimal(10, 0) NULL DEFAULT NULL,
`publishing_time` varchar(20) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
`type_id` int(11) NULL DEFAULT NULL,
`edit_user` char(32) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
`edit_date` bigint(20) NULL DEFAULT NULL,
`sub_desc` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
PRIMARY KEY (`id`) USING BTREE
) ENGINE = MyISAM AUTO_INCREMENT = 18 CHARACTER SET = utf8 COLLATE = utf8_general_ci COMMENT = '圖書明細' ROW_FORMAT = Dynamic;
創建Model和controller
php artisan make:model Models/Book_detail
php artisan make:controller BookdetailController
在Model中添加如下內容表示關聯
/**
* 關聯到模型的數據表
*
* @var string
*/
protected $table = 'book_detail';
/**
* 表明模型是否應該被打上時間戳
*
* @var bool
*/
public $timestamps = false;
/**
* 關聯類型表
*/
public function booktype()
{
return $this->belongsTo(Book_type::class,'type_id');
}
在controller和api.php中創建一個方法
//查詢某個分類下的所有圖書
public function findbookbytype($type_id)
{
$users = Book_detail::where('type_id', $type_id)->get();
foreach ($users as $user) {
$user->type_name=$user->booktype->type_name;
}
return response()->json(['status'=>1,'msg'=>'查詢成功!','data'=>$users]);
}
Route::any('/getbook/{type_id}', 'BookdetailController@findbookbytype');
通過$user->type_name=$user->booktype->type_name;
可以將關聯表中的數據取出
前臺數據樣式爲
6.查詢數據字段篩選
很多時候json返回的時候並不需要太多的數據,有時候可能只需要一個id這時候返回大量數據就會使得效率低下,這時候就需要對數據進行篩選
刪選的方式很多,這裏舉集中常用的
定義一個新的content
在比較簡單的單表查詢或者返回數據只有一條的時候,可以通過重新定義一個content對數據字段進行刪選
比如之前寫過的查詢圖書分類,如果只想返回id和name可以這樣改
//根據id查詢圖書類型
public function getType($id)
{
$user = Book_type::find($id);
$collection = collect([
'id' => $user->id,
'type_name' => $user->type_name
]);
return response()->json($collection);
}
查詢的時候直接通過get對字段進行篩選
可以在查詢的時候直接選擇讀取數據
//根據id查詢圖書類型
public function getType($id)
{
$user = Book_type::where('id', $id)->get(['id', 'type_name']);;
return response()->json($user);
}
如果使用這種方式篩選,就不能通過之前的關聯語句取出關聯表的數據,因爲
//查詢某個分類下的所有圖書
public function findbookbytype($type_id)
{
$users = Book_detail::where('type_id', $type_id)->get(['id', 'title','type_id']);
foreach ($users as $user) {
$user->type_name=$user->booktype->type_name;
}
return response()->json(['status'=>1,'msg'=>'查詢成功!','data'=>$users]);
}
通過此方法將關聯表數據取出
返回的json會將type對應的字段重新全部取出一遍
通過with直接進行關聯查詢
$users = Book_detail::where('type_id', $type_id)->
with(['booktype'=>function($query){
$query->select('id','type_name');
}])->get(['id', 'title','type_id']);
return response()->json(['status'=>1,'msg'=>'查詢成功!','data'=>$users]);
左關聯查詢
在with關聯的時候,從表的數據會包在主表下面,如果你想讓他們平級取出來,可以通過左關聯查詢
//查詢某個分類下的所有圖書 java
public function findbookbytype($type_id)
{
$users = Book_detail::where('type_id', $type_id)
->select(['book_detail.id as detail_id','book_detail.title','book_type.id as type_id','book_type.type_name'])
->leftJoin('book_type', 'book_type.id', '=', 'book_detail.type_id')
->get();
return response()->json(['status'=>1,'msg'=>'查詢成功!','data'=>$users]);
}