README

使用

在 bootstrap 中新增

$app->register(Espier\Swagger\Providers\SwaggerServiceProvider::class);

然后执行命令，将 swagger UI 的资源拷贝到 public 目录中。

php artisan api:swagger --setup

如需生成指定目录的 swagger API json 文件，则使用

php artisan api:swagger --output=[/path/to/project];

默认 JSON 文件生成目录为 Storage 的 apidocs 中，可通过在 .env 中新增配置来改变存储目录名称。

SWAGGER_STORAGE_DIR=apidocs

生成 API JSON 文件后通过路由访问。

http://example.com/api-doc

如果需要改变路由名称，则可以通过 .env 配置。

SWAGGER_DOCS_ROUTER=api-doc

如果需要使用 mock server，则必须安装 PHP 的 Yaml 扩展，并且启动 mock server 服务。

php artisan api:swagger --mock-server-start

在开发阶段，因为团队中每个人的环境配置不一致，API 需要绑定不同的访问地址。那么就不能使用 API 中定义的 host 和 basePath 作为测试地址。为了便于个人开发测试，可以通过 .env 配置个人的 host 和 basePath。

SWAGGER_API_HOST=
SWAGGER_API_BASE_PATH=