README

截至 2020 年 4 月 18 日，Laravel Route Browser 已停止维护。

它最初是一个实验性项目，旨在了解 Laravel 的路由系统并创建一个比 artisan route:list 更好的 UI，但维护它所需的努力（尤其是当 Laravel 路由内部改变时）超过了其带来的好处。

— 大衛

Laravel Route Browser

Laravel 的基于 Web 的路由列表 GUI。

(类似于 Pretty Routes，Laravel Routes Explorer 和 Laravel Route Summary，但提供更多详细信息并具有更好的搜索功能。)

兼容性图表

Laravel Route Browser	Laravel	PHP
1.1.1+	5.6+	7.1+
1.0.0 – 1.1.0	5.6 – 6.x	7.1+

安装

composer require --dev davejamesmiller/laravel-route-browser

可选地发布和编辑配置文件（config/route-browser.php）

php artisan vendor:publish --tag=route-browser-config

然后访问 /routes（或您配置文件中设置的路径）。

出于安全考虑，默认情况下，Route Browser 仅在 APP_ENV=local 和 APP_DEBUG=true 时生效，或者您在 .env 中设置 ROUTE_BROWSER_ENABLED=true。您不应该在生产或任何公开可访问的环境中启用它。

贡献

文档：如果您认为文档可以在任何方面得到改进，请编辑此文件并提交一个 pull request。

错误修复：请修复它并提交一个 pull request。 (以下提供了更详细的说明。) 如果您添加单元测试以确保不会再次发生，则可以获得额外的加分！

新功能：请构建它并提交一个拉取请求。如果您在进行大量工作之前想讨论它，请创建一个原型（可以是代码或文档）并提交一个草稿 PR来讨论细节。

创建拉取请求

在 Laravel 路由浏览器上工作的最简单方法是告诉 Composer 使用 --prefer-source 标志从源（Git）安装它

rm -rf vendor/davejamesmiller/laravel-route-browser
composer install --prefer-source

然后检出 master 分支，并创建一个本地分支进行工作

cd vendor/davejamesmiller/laravel-route-browser
git checkout -t origin/master
git checkout -b YOUR_BRANCH

现在进行您的更改，包括单元测试和文档（如果适用）。运行单元测试以确保一切仍然正常工作

scripts/test.sh

然后提交更改。如果您还没有，请先在 GitHub 上分叉存储库，并将您的更改推送到它

git remote add YOUR_USERNAME git@github.com:YOUR_USERNAME/laravel-route-browser.git
git push -u YOUR_USERNAME YOUR_BRANCH

最后，浏览到 GitHub 上的存储库并创建一个拉取请求。

(另外，您还可以使用测试应用程序。)

在项目中使用您的分叉

要使用您自己的分叉在项目中使用，按照以下方式更新主项目中的 composer.json

{
    // ADD THIS:
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/YOUR_USERNAME/laravel-route-browser.git"
        }
    ],
    "require": {
        // UPDATE THIS:
        "davejamesmiller/laravel-route-browser": "dev-YOUR_BRANCH"
    }
}

将 YOUR_USERNAME 替换为您的 GitHub 用户名，将 YOUR_BRANCH 替换为分支名称（例如 develop）。这告诉 Composer 使用您的存储库而不是默认存储库。

单元测试

要运行单元测试

scripts/test.sh

要检查代码覆盖率

scripts/test-coverage.sh

然后打开 test-coverage/index.html 查看结果。请注意 PHPUnit 中的边缘情况，这可能会导致它并不完全准确。

Laravel 的新版本

在 composer.json 中没有指定最大版本，因此不需要每 6 个月发布新的 Laravel 路由浏览器版本。然而，需要更新此文件以运行针对新版本的测试

.travis.yml
- matrix（Laravel 版本）
- php（PHP 版本）
- exclude（不支持的组合）

如果需要更改，请更新以下内容

README.md
- 兼容性图表
- 变更日志

如果向后不兼容的更改导致 Laravel 或 PHP 的最低支持版本发生变化，请更新

composer.json
- php/*
- illuminate/*

发布新版本

本节仅适用于维护者。

确保单元测试已更新（最终将有 100% 的覆盖率）
如果适用，更新测试应用程序，并手动测试它
确保README 已更新，包括
- 记录任何新功能
- 兼容性图表
- 变更日志
将更改合并到 master 分支（如果需要）
将代码更改推送到 GitHub（git push）
确保所有测试都通过
标记版本（git tag 1.2.3）
推送标签（git push --tag）

无技术支持

很抱歉，我不提供任何技术支持，GitHub Issues 已禁用。这意味着我无法找出为什么它对您不起作用，我不会为您修复错误，也不会根据您的要求编写新功能——毕竟，这是一款免费软件。

但是开源的魅力在于您可以随心所欲地使用它！您可以分叉它、修复它、改进它并扩展它。如果您不想维护自己的分叉版本，并且您认为其他人会从您的更改中受益，您可以提交一个 pull request 以将您的更改包含在下一个版本中。

如果您真的遇到了麻烦，我建议您

阅读并重新阅读此文件和 Laravel 文档，看看您是否错过了什么。
深入研究源代码，花点时间弄清楚它是如何工作的以及实际发生了什么。
尝试在全新的 Laravel 项目上重现问题，以防它是与其他包或您其他代码的不兼容性。
如果您是团队的一员，请请求您的同事帮助您调试。
支付给更有经验的人以获得帮助（或者如果您在一家公司工作，请请求您的老板支付给他们）。
尝试在 Stack Overflow、Laravel.io 论坛或 Laracasts 论坛上发布帖子（但我无法保证有人会回答——他们也没有报酬）。
尝试使用不同的包。
自己编写。

变更日志

Laravel 路由浏览器使用语义化版本控制。

v1.1.1 （2020年2月26日星期三）

修复 Laravel 7 中的过滤问题

v1.1.0 （2020年1月17日星期五）

修复在子目录外运行时的 URL 过滤问题——感谢 Nguyễn Trần Chung
将 excludes 数组添加到配置文件中——也要感谢 Nguyễn Trần Chung

v1.0.1 （2020年1月2日星期四）

修复显示闭包中间件的问题
修复在控制器中而不是在路由中添加中间件的问题

v1.0.0 （2019年12月31日星期二）

首次发布

许可证

MIT 许可证

特此授予任何获得此软件及其相关文档文件（以下简称“软件”）副本的任何人，免费使用该软件的权利，不受任何限制，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本的权利，并允许向软件提供方提供软件的人这样做，前提是遵守以下条件

本软件按“原样”提供，不提供任何形式的保证，无论是明示的还是隐含的，包括但不限于适销性、适用于特定目的和非侵权的保证。在任何情况下，作者或版权持有人不对任何索赔、损害或其他责任负责，无论基于合同行为、侵权行为或其他行为，无论源于、产生于或与该软件或使用该软件或以其他方式参与该软件有关。

davejamesmiller / laravel-route-browser

维护者

详细信息