0

0

laravel中dingo是什么

WBOY

WBOY

发布时间:2022-02-23 16:39:39

|

3234人浏览过

|

来源于php中文网

原创

在laravel中,dingo是针对laravel、lumen框架的api开发工具包;主要有路由版本管理、“Http Exception”异常处理和“Response Transform”转化响应格式三个功能。

laravel中dingo是什么

本文操作环境:Windows10系统、Laravel6版、Dell G3电脑。

laravel中dingo是什么

dingo是针对laravel、lumen框架的api开发工具包。

粗看文档目录,基于api规范,它围绕了三个主要功能:

  • 路由版本管理

  • Http Exception 异常处理

  • Response Transform 转化响应格式

dingoapi是一个laravel的开源插件,可以在github上搜索到,现在在做一个项目,项目中总是会有后端跟前端的json数据交互,而这个dingoapi为json交互提供了很大的便利。

路由版本控制

一、相关配置

1声明api服务

api规范要求,接口开发要么带api前缀(http://XXX.com/api/xxx),要么是子域名(http://api.XXX.com/xxx),通过这样的标识,代表请求的是api接口服务。

所以,API_PREFIX=api和API_DOMAIN=api.myapp.com须设置其中一个。

.env可能需要配置的选项

当然它的作用并非只是个标识,我们知道dingo的路由与laravel的路由是共存的,dingo便是通过这个特征来判断的。

2版本控制

dingo提供了自己的路由服务,如果http://XXX.com/api/xxx或http://api.XXX.com/xxx访问,它则认为是api请求,dingo路由服务Dingo\Api\Routing\Router会接管laravel自带的路由服务Illuminate\Routing\Router(至于是如何接管的,之后再说),它同样有get(),post(),match(),group()…方法,相当于另一套路由体系。

laravel区分版本的话,可能需要带上一个v1前缀,例如http://XXX.com/api/v1或者http://XXX.com/api/v2。而dingo是通过 header头Accept处理的。它的格式是Accept: application/vnd.YOUR_SUBTYPE.v1+json。意味着你需要发送一个accept的请求头才能访问。

配置文件中,默认这种模式是不强制的,API_STRICT=false,但只能访问配置文件中默认的版本,'version' => env('API_VERSION', 'v1'),。

如果设置为true,即开启严格模式,则必须发送accept头,不能通过浏览器直接访问你的 API。

.env可能需要配置的选项

API_STRICT=true //开启严格模式必须不论v1,v2都须带上accept头信息

API_VERSION=v1 //在没有声明版本号时的默认版本号

若开启严格模式

关于header头的accept属性几个选项:

Accept: application/vnd.YOUR_SUBTYPE.v1+json

API_STANDARDS_TREE=x,prs,vnd Standards Tree 标准树

API_SUBTYPE=myapp 子类型:程序或项目的短名称

v1:版本号

json:返回的格式,也可以为jsonp

.env可能需要配置的选项

API_STANDARDS_TREE=prs

API_SUBTYPE=lara

API_DEFAULT_FORMAT=json //默认

【相关推荐:laravel视频教程

相关专题

更多
C++ 单元测试与代码质量保障
C++ 单元测试与代码质量保障

本专题系统讲解 C++ 在单元测试与代码质量保障方面的实战方法,包括测试驱动开发理念、Google Test/Google Mock 的使用、测试用例设计、边界条件验证、持续集成中的自动化测试流程,以及常见代码质量问题的发现与修复。通过工程化示例,帮助开发者建立 可测试、可维护、高质量的 C++ 项目体系。

3

2026.01.16

java数据库连接教程大全
java数据库连接教程大全

本专题整合了java数据库连接相关教程,阅读专题下面的文章了解更多详细内容。

26

2026.01.15

Java音频处理教程汇总
Java音频处理教程汇总

本专题整合了java音频处理教程大全,阅读专题下面的文章了解更多详细内容。

12

2026.01.15

windows查看wifi密码教程大全
windows查看wifi密码教程大全

本专题整合了windows查看wifi密码教程大全,阅读专题下面的文章了解更多详细内容。

35

2026.01.15

浏览器缓存清理方法汇总
浏览器缓存清理方法汇总

本专题整合了浏览器缓存清理教程汇总,阅读专题下面的文章了解更多详细内容。

5

2026.01.15

ps图片相关教程汇总
ps图片相关教程汇总

本专题整合了ps图片设置相关教程合集,阅读专题下面的文章了解更多详细内容。

8

2026.01.15

ppt一键生成相关合集
ppt一键生成相关合集

本专题整合了ppt一键生成相关教程汇总,阅读专题下面的的文章了解更多详细内容。

4

2026.01.15

php图片上传教程汇总
php图片上传教程汇总

本专题整合了php图片上传相关教程,阅读专题下面的文章了解更多详细教程。

2

2026.01.15

phpstorm相关教程大全
phpstorm相关教程大全

本专题整合了phpstorm相关教程汇总,阅读专题下面的文章了解更多详细内容。

4

2026.01.15

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Laravel---API接口
Laravel---API接口

共7课时 | 0.6万人学习

PHP自制框架
PHP自制框架

共8课时 | 0.6万人学习

PHP面向对象基础课程(更新中)
PHP面向对象基础课程(更新中)

共12课时 | 0.7万人学习

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

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