安装DingoApi

最新推荐文章于 2025-11-19 00:55:48 发布

原创最新推荐文章于 2025-11-19 00:55:48 发布 · 825 阅读

0 ·

CC 4.0 BY-SA版权

DingoApi 专栏收录该内容

3 篇文章

订阅专栏

本文档介绍了如何安装和配置DingoApi。首先，在composer.json中添加DingoApi的依赖，并执行安装命令。接着，发布DingoApi的配置文件到config目录下，并详细解析了配置选项，如API_STANDARDS_TREE、API_SUBTYPE、API_VERSION和API_STRICT等，以及在.env文件中的相关设置。

1，安装

composer.json

增加两句：

"minimum-stability" : "dev" —— 设定的最低稳定性的版本为 dev 也就是可以依赖开发版本的扩展包；
"prefer-stable" : true —— Composer 优先使用更稳定的包版本。

执行命令安装：

D:\WWW\>composer require dingo/api
Using version ^2.2 for dingo/api
./composer.json has been updated
Loading composer repositories with package information
Updating dependencies (including require-dev)
Package operations: 4 installs, 0 updates, 0 removals
  - Installing league/fractal (0.17.0): Loading from cache
  - Installing doctrine/annotations (v1.6.1): Loading from cache
  - Installing dingo/blueprint (dev-master 76b1621): Cloning 76b1
  - Installing dingo/api (v2.2.3): Loading from cache
league/fractal suggests installing pagerfanta/pagerfanta (Pagerfa
league/fractal suggests installing zendframework/zend-paginator (
dingo/api suggests installing tymon/jwt-auth (Protect your API wi
Writing lock file
Generating optimized autoload files
> Illuminate\Foundation\ComposerScripts::postAutoloadDump
> @php artisan package:discover --ansi
Discovered Package: [32mbeyondcode/laravel-dump-server[39m
Discovered Package: [32mdingo/api[39m
Discovered Package: [32mfideloper/proxy[39m
Discovered Package: [32mlaravel/nexmo-notification-channel[39m
Discovered Package: [32mlaravel/slack-notification-channel[39m
Discovered Package: [32mlaravel/tinker[39m
Discovered Package: [32mnesbot/carbon[39m
Discovered Package: [32mnunomaduro/collision[39m
[32mPackage manifest generated successfully.[39m

dingo/api 已经成功安装了。

2，配置

先将 dingo 的配置文件 publish 出来

 php artisan vendor:publish

在这里插入图片描述
执行成功后，我们会在 config 目录先看到 api.php 文件，打开文件我们可以看到所有的配置都是可以再 env 中修改的，下面我们主要讲解一下我们需要用到的配置
详解：

API_STANDARDS_TREE 和 API_SUBTYPE
API_STANDARDS_TREE 有是三个值可选：
- x 本地开发的或私有环境的
- prs 未对外发布的，提供给公司 app，单页应用，桌面应用等
- vnd 对外发布的，开放给所有用户
API_SUBTYPE
一般情况下是我们项目的简称，我们的项目叫 api
API_VERSION
默认的 API 版本，当我们没有传 Accept 头的时候，默认访问该版本的 API。一般情况下配置 v1 即可。
API_STRICT
是否开启严格模式，如果开启，则必须使用 Accept 头才可以访问 API，也就是说直接通过浏览器，访问某个 GET 调用的接口，将会报错。必须使用 Postman 之类的调试工具，设置 Accept 后才可访问。可以根据需求开启，默认情况下为 false。
API_DEBUG
测试环境，打开 debug，方便我们看到错误信息，定位错误。

.env 文件

API_STANDARDS_TREE=prs
API_SUBTYPE=api
API_PREFIX=api
API_VERSION=v1
API_DEBUG=flase