Laravel Swagger 生成 API 文档

最新推荐文章于 2024-10-22 11:56:47 发布

qq_27084325

最新推荐文章于 2024-10-22 11:56:47 发布

阅读量1k

点赞数

CC 4.0 BY-SA版权

文章标签： swagger laravel

本文链接：https://blog.csdn.net/qq_27084325/article/details/101206185

本文档介绍了如何在Laravel项目中使用L5-Swagger包生成API文档，包括安装包、解决UI不显示的问题以及提供相关学习资源。通过安装特定插件，设置别名以实现代码注释提示，并解决Swagger UI的静态文件引用问题。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Laravel Swagger 生成 API 文档

1. 安装 `l5-swagger` 包

https://github.com/DarkaOnLine/L5-Swagger

composer require "darkaonline/l5-swagger:5.5.*"

php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider"

# 编写问题
composer require 'zircote/swagger-php:2.*'

# 使用 ui 界面
php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider"

# .env 

# 指定版本
SWAGGER_VERSION=2.0

# 实时更新
L5_SWAGGER_GENERATE_ALWAYS=true