当前位置: 首页 > 后端技术 > PHP

Swagger系列一:在laravel中部署swaggerui

时间:2023-03-29 23:39:41 PHP

一、将swaggerui部署到项目中:可以gitdowngitclonehttps://github.com/swagger-api/swagger-uiv也可以下载zip文件。解压后,将目录下的dist目录复制到laravel下public下的文件夹中,比如新建一个docs。访问http://localhost/docs/2。修改为自己的工程文件。打开index.html下的docs(即dist下的index.html)。找到url:“http://petstore.swagger.io/v2/swagger.json”,把url改成自己的,比如url:“swagger.json”,再次访问。但是swagger.json不存在,需要生成。3.swagger-php从代码和现有的phpdoc注释中提取信息,为您的RESTfulAPI生成交互式Swagger文档。兼容Swagger2.0规范。在Laravel项目中安装swagger-php:$composerrequirezircote/swagger-php也可以指定版本安装:composerrequirezircote/swagger-php2.0.13指定版本2.0.134.安装完成后,你可以使用swagger-php测试示例测试。例如:public下的docs目录用于存放swagger.json文件。执行命令:$phpvendor/zircote/swagger-php/bin/swaggervendor/zircote/swagger-php/Examples-opublic/docs再次访问。界面可能看起来和swaggerui默认的一样,因为用的是同一个模板,不过以后可以用自己注释生成的swagger.json文件覆盖。