0

0

[laravel]如何用 lumen 构建 API

php中文网

php中文网

发布时间:2016-06-20 12:27:14

|

1424人浏览过

|

来源于php中文网

原创

什么是 API

Sylius开源电子商务平台
Sylius开源电子商务平台

Sylius开源电子商务平台是一个开源的 PHP 电子商务网站框架,基于 Symfony 和 Doctrine 构建,为用户量身定制解决方案。可管理任意复杂的产品和分类,每个产品可以设置不同的税率,支持多种配送方法,集成 Omnipay 在线支付。功能特点:前后端分离Sylius 带有一个强大的 REST API,可以自定义并与您选择的前端或您的微服务架构很好地配合使用。如果您是 Symfony

下载

API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。

什么是 lumen

Lumen 是一个由 Laravel 组件搭建而成的微框架, 由 Laravel 官方维护. Lumen 为速度而生, 是当前最快的 PHP 框架之一, 甚至比类似的微框架 Silex 速度还要快.从上面可以看出 Lumen 是去除了很多 配置和可自定义的选项的 Laravel。也就是说如果你先了解了 Laravel 就很容易掌握 lumen,在博客里有很多 laravel 的文章,大家可以搜一下去学习 。

用 lumen 开发 Api

首先要把 lumen 配置好,加入需要的 JWT,dingo 等组件。但在我们的项目中这些都是配置好的,这些你都不用担心。

构建路由

打开项目目录app/Http/routes.php

<?php$api = app('Dingo\Api\Routing\Router');  $api->version('v1.0',  ['namespace' => 'App\Http\V1_0\Controllers'],  function ($api) { //物品分类列表$api->get('category',  'CategoryController@index'); //验证项目是否运行成功$api->get('test', 'ApitestController@test'); // 需提供 JWT$api->group(['middleware' => 'api.auth', 'providers' => 'jwt'], function ($api) { });}); 

上面是最初打开看到的界面,很多人可能不理解是什么意思。去看 lumen 文档也和上面不太一样。事实上上面并不是 lumen 的原生语法,上面用到的是 dingo API。可以去以下链接了解 Wiki documentation。我在这里简单介绍下。

$api->get('test', 'ApitestController@test');//访问本地地址/api/test,调用的方法是 ApitestController 的 test 方法 

而在这个里面

$api->group(['middleware' => 'api.auth', 'providers' => 'jwt'], function ($api) { }); 

写下的路由必须通过 JWT 验证,就是必须要登录获取 token。大家可以去 JWT 官网或搜一下相关文章了解 token 机制。 WIKI可以了解如何获取和解析 token。当然如果你的任务不需要获取 登录,可略过。

路由要遵循 restful url 规范。大家可以看下这篇文章 restful url

用到最多的是 laravel resource 路由

控制器

还记得上步里提到的那个路由吗,在那个路由调用的是 ApitestController 的 test 方法。接下来我们就来写一下这个控制器

打开项目目录

app/Http/V1_0/Controllers,我们项目的控制器都写在这个文件夹下,根据需要新建 ApitestController

<?phpnamespace App\Http\v1_0\Controllers; class ApiTestController extends ApiController{public function test(){return $this->response()->array(['api 项目运行成功']);}} 

在这里有个 test 方法,就是我们在上一步的路由中访问的方法。也就是说当我们访问本地地址/api/test 时就会回应 ‘api 项目运行成功’。到此我们的 API 经过的流程就基本完成了。不过可能会有很多同学会问数据库呢?事实上数据库也只是为这个 Api 提供数据而已。

数据库

在这里我们将展示数据库的数据如何在控制器中使用。首先新建 migration,大家参考这篇文章。有的时候还要填入数据,大家

参考这篇文章

然后我们要建立一个 Model。假设我们现在有一个 users 表。

打开 app/Entity 文件夹 新建文件 User.php

<?phpnamespace App\Entity; use Illuminate\Database\Eloquent\Model; class User extends Model {protected $hidden =  ['password'];protected $fillable = ['nation_id', 'mobile'];} 

$fillable 是允许批量操作的白名单,具体的大家可以去看看官网。接下来我们就可以使用 users 这个表了。方法改为

public function test(){$users = User::all();return $this->response->collection($users, new UserTransformer);} 

在前面加上 use App\Entity\User;

这里用到了 Transformer,必须要新建个文件, 可以看下这篇文章。如果不想建,可以直接 return $users;这样当访问连接时会返回 users 表的数据。了解更多,可以去看官方文档的数据库一节。很多时候为了方便,我们分离数据库层,可以参考这篇文章。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

463

2026.02.13

微博网页版主页入口与登录指南_官方网页端快速访问方法
微博网页版主页入口与登录指南_官方网页端快速访问方法

本专题系统整理微博网页版官方入口及网页端登录方式,涵盖首页直达地址、账号登录流程与常见访问问题说明,帮助用户快速找到微博官网主页,实现便捷、安全的网页端登录与内容浏览体验。

135

2026.02.13

Flutter跨平台开发与状态管理实战
Flutter跨平台开发与状态管理实战

本专题围绕Flutter框架展开,系统讲解跨平台UI构建原理与状态管理方案。内容涵盖Widget生命周期、路由管理、Provider与Bloc状态管理模式、网络请求封装及性能优化技巧。通过实战项目演示,帮助开发者构建流畅、可维护的跨平台移动应用。

64

2026.02.13

TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

20

2026.02.13

Redis高可用架构与分布式缓存实战
Redis高可用架构与分布式缓存实战

本专题围绕 Redis 在高并发系统中的应用展开,系统讲解主从复制、哨兵机制、Cluster 集群模式及数据分片原理。内容涵盖缓存穿透与雪崩解决方案、分布式锁实现、热点数据优化及持久化策略。通过真实业务场景演示,帮助开发者构建高可用、可扩展的分布式缓存系统。

26

2026.02.13

c语言 数据类型
c语言 数据类型

本专题整合了c语言数据类型相关内容,阅读专题下面的文章了解更多详细内容。

29

2026.02.12

雨课堂网页版登录入口与使用指南_官方在线教学平台访问方法
雨课堂网页版登录入口与使用指南_官方在线教学平台访问方法

本专题系统整理雨课堂网页版官方入口及在线登录方式,涵盖账号登录流程、官方直连入口及平台访问方法说明,帮助师生用户快速进入雨课堂在线教学平台,实现便捷、高效的课程学习与教学管理体验。

14

2026.02.12

豆包AI网页版入口与智能创作指南_官方在线写作与图片生成使用方法
豆包AI网页版入口与智能创作指南_官方在线写作与图片生成使用方法

本专题汇总豆包AI官方网页版入口及在线使用方式,涵盖智能写作工具、图片生成体验入口和官网登录方法,帮助用户快速直达豆包AI平台,高效完成文本创作与AI生图任务,实现便捷智能创作体验。

524

2026.02.12

PostgreSQL性能优化与索引调优实战
PostgreSQL性能优化与索引调优实战

本专题面向后端开发与数据库工程师,深入讲解 PostgreSQL 查询优化原理与索引机制。内容包括执行计划分析、常见索引类型对比、慢查询优化策略、事务隔离级别以及高并发场景下的性能调优技巧。通过实战案例解析,帮助开发者提升数据库响应速度与系统稳定性。

53

2026.02.12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Go语言实战之 GraphQL
Go语言实战之 GraphQL

共10课时 | 0.8万人学习

开源物联网开发实例
开源物联网开发实例

共6课时 | 0.4万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号