189 8069 5689

laravel中的dingo有什么作用

这篇文章主要介绍“laravel中的dingo有什么作用”,在日常操作中,相信很多人在laravel中的dingo有什么作用问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”laravel中的dingo有什么作用”的疑惑有所帮助!接下来,请跟着小编一起来学习吧!

成都创新互联公司专业为企业提供海西网站建设、海西做网站、海西网站设计、海西网站制作等企业网站建设、网页设计与制作、海西企业网站模板建站服务,10余年海西做网站经验,不只是建网站,更提供有价值的思路和整体网络服务。

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

本文操作环境: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中的dingo有什么作用”的学习就结束了,希望能够解决大家的疑惑。理论与实践的搭配能更好的帮助大家学习,快去试试吧!若想继续学习更多相关知识,请继续关注创新互联网站,小编会继续努力为大家带来更多实用的文章!


当前名称:laravel中的dingo有什么作用
链接分享:http://cdxtjz.com/article/iihidp.html

其他资讯