swagger系列一:laravel中部署swagger ui

1. 部署swagger ui 到项目中:

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

《swagger系列一:laravel中部署swagger ui》

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文件重新覆盖即可。

    原文作者:Rango
    原文地址: https://segmentfault.com/a/1190000014059501
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞