2.13. 命令行工具

未匹配的标注

Dingo API 同时支持 Laravel 和 Lumen 两个框架,但是因为框架的用途不一样,命令的支持也不一样,支持情况请见下表:

Laravel Lumen
api:routes
api:cache
api:docs

api:routes

只有 Laravel 5.1 及以上版本可以使用

这个命令将生成你的 API 路由列表。这个命令的效果类似 Laravel 中的 route:list 命令。除了标准的使用方法,你还可以使用以下的过滤器:--versions--scopes

例子

$ php artisan api:routes
$ php artisan api:routes --versions v1
$ php artisan api:routes --scopes read_user_data --scopes write_user_data

api:cache

只有 Laravel 5.1 及以上版本可以使用

这个命令将缓存你的 API 路由,和你主要应用的路由一起。当执行这个命令的时候会自动执行 route:cache 命令。所以执行完这个命令后就不要在执行 route:cache 了。

你的路由需要出现在你的 app/Http/routes.php 文件中或者被这个文件引入的文件中,从而让缓存个生效。

Important: Running route:cache by itself will prevent your API routes from being accessible.

例子

$ php artisan api:cache

api:docs

只有 Laravel 5.1 及以上版本和 Lumen 5.1及以上版本可以使用

这个命令将从你的控制器注释中生成文档到一个符合标准的 api 文档中。更多的如何注释你的控制器请看 API Blueprint Documentation 章节。

默认的,这个命令将把文档输出到 stdout 中,你可以使用管道将这个文件存储到一个文件中或者推送到服务器上。

例子

$ php artisan api:docs --name Example --use-version v2

文件的输出目录 使用 --output-file

$ php artisan api:docs --name Example --use-version v2 --output-file /path/to/documentation.md

为了避免手动定义名字和版本,你可以自定义配置到你的配置文件或者环境文件中。详情请看 配置信息 章节。

本文章首发在 LearnKu.com 网站上。

本译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。
上一篇 下一篇
Summer
《L01 基础入门》
我们将带你从零开发一个项目并部署到线上,本课程教授 Web 开发中专业、实用的技能,如 Git 工作流、Laravel Mix 前端工作流等。
《L03 构架 API 服务器》
你将学到如 RESTFul 设计风格、PostMan 的使用、OAuth 流程,JWT 概念及使用 和 API 开发相关的进阶知识。
贡献者:4
讨论数量: 0
发起讨论 只看当前版本


暂无话题~