在您的 Laravel 应用程序中添加 Swagger UI
最后更新于 作者: Paul Redmond
Laravel Swagger UI 软件包使您能够轻松地将项目的 Swagger (OpenAPI v3 JSON 或 YAML) 文件在 Laravel 应用程序中的 Swagger UI 中访问。您只需将 OpenAPI 文件放到 resources/swagger/openapi.json
(可配置) 并导航到项目中的本地 /swagger
我喜欢这个软件包的原因是它会自动更新 Swagger UI 以使用当前项目的环境,包括将 API 的基本 URL 设置为 Laravel 项目的基本 URL。该软件包还允许您配置 OAuth2,它可以通过软件包的配置文件注入到 Swagger UI 中。
/swagger
URL 在本地是可访问的,您也可以定义自定义门控逻辑来授权并在非本地环境中为 Swagger UI 提供访问控制。
Gate::define('viewSwaggerUI', function ($user = null) { // Custom logic here... return in_array(optional($user)->email, [/*...*/]);});
您可以在 nextapps-be/laravel-swagger-ui 上了解更多关于该软件包的信息,获取完整的安装说明,并查看源代码。