artisansdk/blueprint

适用于Laravel的API蓝图渲染器。

dev-master 2023-07-10 18:56 UTC

This package is auto-updated.

Last update: 2024-09-10 21:42:37 UTC


README

适用于Laravel的API蓝图渲染器。

目录

安装

蓝图可以作为独立应用程序安装,可以在本地开发并服务静态资源。

composer create-project artisansdk/blueprint

与任何其他PHP包一样,蓝图包会被安装到PHP应用程序中。

composer require artisansdk/blueprint

使用指南

如果作为独立应用程序设置,以下命令可用:

bin/blueprint export [--format=html]
bin/blueprint serve [--host=127.0.0.1] [--port=8000] [--tries=10]

如果安装到Laravel项目中,以下命令已被注册:

php artisan blueprint:export [--format=html]
php artisan blueprint:serve [--host=127.0.0.1] [--port=8000] [--tries=10]

此外,还有Composer脚本来包装这些命令。

composer export
composer serve
composer watch

注意:`composer watch` 脚本依赖于 watchman-make 来监视Blade和配置文件的变化,然后自动将API蓝图重新导出为HTML。

蓝图开发

通常在API蓝图的开发过程中,开发者会调整API蓝图的内容,同时也可能修改Blade模板和相应的样式表。打开3个独立的终端,并运行以下命令以监视资源变化和模板变化,并托管开发PHP服务器:

yarn watch
composer watch
composer serve

许可

版权所有 (c) 2023 Artisan Made

此软件包根据MIT许可证发布。有关商业许可条款,请参阅代码副本中分发的LICENSE文件。