Laravel8扩展swagger

安装和配置

  • composer require "darkaonline/l5-swagger" //目前是最新的
  • php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider"
  • php artisan l5-swagger:generate

访问

在控制器中创建文件

//可以指定server和端口 如果不写默认本机
/**
 * @OA\Info(
 *     title="Auth api",
 *     version="0.0.1"
 * )
 * @OA\Server(
 *     url="http://xx.xxx.xx.xxx:xxx"
 * ),
 */
class LoginController extends Controller{
/**
     * @OA\Get(
     *     path="/projects",
     *     @OA\Response(response="200", description="Display a listing of projects.")
     * )
     */
    public function test()
    {
        return 'test -> user';
    }

}

执行 php artisan l5-swagger:generate

参考1:在laravel中集成swagger_小小郭-CSDN博客
参考2:无法在 l5-swagger 中生成 API 文档 - 堆栈内存溢出
参考3:darkaonline/l5-swagger - Packagist


github地址:GitHub - DarkaOnLine/L5-Swagger: OpenApi or Swagger integration to Laravel

学习资源#

  1. swagger-php guide
  2. swagger-php 里面有例子,但是我发现好像不是很全
  3. Swagger Editor
  4. swagger 文档
  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值