指南
规范
了解如何自动生成 OpenAPI 规范。
内置的 OpenAPI 规范生成功能让你无需修改任何代码即可生成规范。
php artisan orion:specs
该命令会在 storage/app/specs 目录下创建一个 specs.json 文件。
自定义
Info 与 Servers
规范中的 info 和 servers 字段由 orion.php 配置文件填充：
'specs' => [
'info' => [
'title' => env('APP_NAME'),
'description' => null,
'terms_of_service' => null,
'contact' => [
'name' => null,
'url' => null,
'email' => null,
],
'license' => [
'name' => null,
'url' => null,
],
'version' => '1.0.0',
],
'servers' => [
['url' => env('APP_URL').'/api', 'description' => 'Default Environment'],
],
],
如果你还没有发布配置文件，可以运行以下命令来发布：
php artisan vendor:publish --tag=orion-config
文件路径
如果你希望将文件存储在其他路径（例如 storage/app/specs/example.yaml），只需提供 --path 选项即可轻松自定义。请注意，给定的路径是相对路径。
php artisan orion:specs --path="specs/example.yaml"
文件格式
默认情况下，规范文件以 .json 格式存储。不过，只需提供 --format 选项，即可将其存储为 .yaml 格式。
php artisan orion:specs --format="yaml"
已有规范
如果你已经有自定义端点及其 OpenAPI 规范，只需将现有的规范文件放在 storage/app 目录下的任意位置，并通过 --path 选项提供给该命令。它会为标准端点生成规范，并将其与现有的（自定义）规范合并。请注意，给定的路径是相对路径。
php artisan orion:specs --path="specs/existing-specs.json"
目前，生成器仅支持标准端点（由 Orion 提供）。你创建的任何自定义端点的规范都不会被生成。
不过，我们计划在后续版本中支持这一功能。