温馨提示×

温馨提示×

您好,登录后才能下订单哦!

密码登录×
登录注册×
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》

Laravel中如何实现专业的RestfulAPI

发布时间:2021-01-27 15:08:30 来源:亿速云 阅读:236 作者:小新 栏目:编程语言

这篇文章主要介绍了Laravel中如何实现专业的RestfulAPI,具有一定借鉴价值,感兴趣的朋友可以参考下,希望大家阅读完这篇文章之后大有收获,下面让小编带着大家一起了解一下。

Laravel教你简单写出专业的URL

引言

在我们连接了数据库,并且使用迁移功能创建了数据库表结构,

使用Seeder为数据库初步填充了一些伪数据。有了这些准备工作,我们可以考虑做一个资源接口功能,

对外提供数据支持了。

Laravel中如何实现专业的RestfulAPI

代码时间

有没有感觉自己设计的API接口和数据跟别的大厂提供的文档数据结构不太一样,

看上去不是那么专业,或者说不是那么标准?我们和大厂还差几个年级?

laravel提供了简单的标准方式,可以让我们遵循最佳实践写出专业的url。

比如对于资源,使用restful风格声明一下的url路由地址:

Laravel中如何实现专业的RestfulAPI

第一列是http请求方法,第二列是laravel内声明的路由规则,第三列是对应的控制器方法。上面的资源列表,涵盖了增删改查的所有动作,可以说很全面了。

如何快捷地生成上述控制器方法呢?使用laravel脚手架指令,在命令行运行:

php artisan make:controller EventsController --resource

我们使用 –resource 选项,会在目标控制器内生成上述的所有方法。

生成的文件位于 app/Http/Controllers/EventsController.php 内,初始化的内容如下:

Laravel中如何实现专业的RestfulAPI

这些方法真的是开箱即用啊。

那么,我们还要手动一条一条地声明上面的那些路由条目吗?那真是噩梦啊。还好,laravel帮我们做好了,只用Route类的 resource 方法注册资源就可以了:

Route::resource('events', 'EventsController');

使用资源路由方法,只用指定路由名称,和对应的控制器方法,就可以不用繁琐地写那些路由,和控制器方法了。

为方便展示,我们把数据渲染到视图文件,首先创建 resources/views/events/index.blade.php 视图文件,使用默认的布局文件,填充以下代码:

@extends('layouts.app')
@section('content')
    <h2>Events</h2>
@endsection

打开 app/Http/Controllers/EventsController 文件并修改 index 方法:

public function index(){
    return view('events.index');}

大家看到了,上述方法内是没有数据库数据交互的,我们下面引入模型,并渲染到视图内。在控制器顶部添加如下引用:

use App\Event;

index方法内填充以下代码:

$events = Event::all();return view('events.index')->with('events', $events);

有了以上的数据,在视图内简单地遍历输出内容,修改视图文件如下:

<h2>Events</h2><ul>
    @forelse ($events as $event)
        <li>{{ $event->name }}</li>
    @empty        <li>No events found!</li>
    @endforelse</ul>

模板文件内@forelse 方法会判断是否 $events 变量至少有一个元素可供遍历,如果没有就输出 @empty区块的内容。在浏览器内访问路由地址,输出内容大致如下图。因为使用的Faker填充的伪数据,所以看上去是这样的:

Laravel中如何实现专业的RestfulAPI

如果数据量太大,这一页估计要加载很久,列表很长。所以需要分页了。加入分页功能,使用的SQL语句大概是这样的:

select id, name from events order by id asc limit 10 offset 0;
select id, name from events order by id asc limit 10 offset 10;

控制器内使用分页功能,简单对模型调用paginate方法即可:

$events = Events::paginate(10);

每页设置为10条。我们在视图内,要有一个前一页,后一页,以及页码的导航条,也不用我们手动写了。laravel竟然继承到了paginate方法所返回的 Illuminate\Pagination\LengthAwarePaginator 类内,只用在视图内添加这样一行就够了:

{!! $events->links() !!}

生成的导航条如下:

Laravel中如何实现专业的RestfulAPI

写在最后

本文简明扼要地介绍了laravel数据库填充所使用的方法,我们可以手动填充,

也可以使用第三方库填充伪数据,效率明显提升很多。也只要准备好了数据,

才能谈得上业务逻辑和接口对接。这些数据也是应用程序的基础,所以很重要。

本文是对上一章所述laravel数据库迁移功能的补充。数据库迁移是一个比较大的动作,

特别是已经上线生产的应用数据库,如果非到更新迁移的地步不可,需要预期做好演练,

以应对可能的突发事故。                        

感谢你能够认真阅读完这篇文章,希望小编分享的“Laravel中如何实现专业的RestfulAPI”这篇文章对大家有帮助,同时也希望大家多多支持亿速云,关注亿速云行业资讯频道,更多相关知识等着你来学习!

向AI问一下细节

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

AI