使用Laravel5编写API

说明

这篇文章仅为本人如何使用Laravel 5框架编写API，也许有更好的写法，欢迎吐槽。
以下使用的Laravel版本为5.4

参考

Laravel：
Laravel 官网
 Laravel China
Laravel 学院
 Go Laravel
CODECAST(原Laravist)

创建项目

在www目录上使用composer安装laravel项目

composer create-project laravel/laravel=5.4.* laravel-api --prefer-dist

create-project 是使用 Composer 从现有的包中创建一个新的项目。这相当于执行了一个 git clone 或 svn checkout 命令后将这个包的依赖安装到它自己的 vendor 目录。参考composer中文网
laravel/laravel=5.4.* 表示要安装laravel看框架，并指定为5.4以上的版本
laravel-api 是指定要安装的目录，比如想要安装到 blog 目录的话，那么可以把这一段替换成 blog。参考composer中文网基本用法-包版本
--prefer-dist 下载包的方式有两种： source 和 dist。对于稳定版本 composer 将默认使用 dist 方式。而 source 表示版本控制源。--prefer-dist表示composer 将尽可能的从 dist 获取，这将大幅度的加快在 build servers 上的安装。参考composer中文网安装-参数

composer创建Laravel项目

创建数据库和数据表

新建数据库 laravel-api-teach
更新数据库配置
修改项目根目录的 .env 文件（这个文件在Laravel安装好之后会自动生成，如果没有生成，请复制根目录的 .env.example 文件复制一份并重命名为 .env。后面有些laravel基础部分，在官方文档里有的将不再复述，请直接去官方文档查看）

.env文件数据库配置

新建用户表

users

CREATE TABLE `users` (
  `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
  `name` varchar(255) CHARACTER SET utf8 DEFAULT NULL COMMENT '用户名',
  `phone` varchar(20) CHARACTER SET utf8 NOT NULL DEFAULT '' COMMENT '手机号码',
  `created_at` timestamp NULL DEFAULT NULL COMMENT '创建时间',
  `updated_at` timestamp NULL DEFAULT NULL ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='用户表';

在 app\Models 新建 users 表模型

php artisan make:model Models/User

app\Models\User.php

User模型

创建控制器

php artisan make:cotroller UserController

app\Http\Controllers\UserController.php

User控制器

新增 getUser()方法用来获取用户信息

UserController

<?php

namespace App\Http\Controllers;

use App\User;
use Illuminate\Http\Request;

class UserController extends Controller
{

    public function getUser($id)
    {
        $user = User::find($id);
        return response()->json($user);
    }

}

注意api接收数据与返回数据一般是通过json格式进行传输的，所以返回数据的时候，一般是使用

echo json_encode($data);

不过Laravel提供了自带的函数 response()，可以指定返回json格式的数据

API路由

如果仔细看根目录下的 routes 即路由目录，就会发现有4个php文件，其中 web.php是访问web页面时的路由，而 api.php则是访问API时的路由。
下面我们给 UserController 的 getUser() 方法写一个路由吧

routes\api.php

<?php

use Illuminate\Http\Request;

Route::post('/user/{id}', 'UserController@getUser');

访问API

那么现在开始访问写好的这个API吧

访问Laravel的API路由，是需要在域名后面加上api，与web路由不同

http://xxxxx.com/api/user/1

访问获取用户信息API