使用Laravel5编写API

说明

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

参考

Composer:
Composer中文网
Composer中文文档

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时的路由。
下面我们给 UserControllergetUser() 方法写一个路由吧

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
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,491评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,856评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,745评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,196评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,073评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,112评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,531评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,215评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,485评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,578评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,356评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,215评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,583评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,898评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,174评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,497评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,697评论 2 335

推荐阅读更多精彩内容

  • 必备品文档:DocumentationAPI: API Reference视频:Laracasts速查表:Lara...
    ethanzhang阅读 5,738评论 0 68
  • Awesome PHP 一个PHP资源列表,内容包括:库、框架、模板、安全、代码分析、日志、第三方库、配置工具、W...
    guanguans阅读 5,735评论 0 47
  • 原文链接 必备品 文档:Documentation API:API Reference 视频:Laracasts ...
    layjoy阅读 8,591评论 0 121
  • 是什么 如果你知道yum、apt-get、npm、bower等命令中的一种或者多种,那么,你也能很快知道compo...
    旱魃一样阅读 3,101评论 0 9
  • 绘画小白第一次画人物,肯定是很丑很丑啦。没错,我就是丑的给你们开心的。
    如磨如啄阅读 430评论 0 2