swagger系列一:laravel中部署swagger ui

本文详细介绍如何将SwaggerUI部署到Laravel项目中,并通过swagger-php从代码和现有的phpdoc注释中提取信息来生成交互式的Swagger文档。

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

1. 部署swagger ui 到项目中:

可以Git下来 git clone https://github.com/swagger-api/swagger-uiv
也可以下载zip文件。解压后把目录下的dist目录拷贝到 laravel下public下的文件夹中,如新建docs。访问http://localhost/docs/

图片描述

2. 修改为自己的项目文件。

打开docs(即dist下index.html)下index.html。找到url: "http://petstore.swagger.io/v2/swagger.json",,把URL修改为自己的,如url: "swagger.json",,再次访问即可。但是swagger.json并不存在,需要生成。

3. swagger-php从代码和现有的phpdoc注释中提取信息,为您的RESTful API 生成交互式Swagger文档。与Swagger 2.0规范兼容。

在Laravel项目中安装swagger-php:
$ composer require zircote/swagger-php
也可以指定版本安装 : composer require zircote/swagger-php 2.0.13 指定的2.0.13版本

4. 安装完成后,可以用swagger-php测试示例测试。

如:放在public下的docs目录,用于存放swagger.json文件。执行命令:
$php vendor/zircote/swagger-php/bin/swagger vendor/zircote/swagger-php/Examples -o public/docs
再次访问即可。界面或许看起来和swagger ui的默认一样,是因为用的同样的模板,但是以后用自己的注释生成的swagger.json文件重新覆盖即可。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值