Laravel5.7：简单接口编写

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]);
    }