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
文件重新覆盖即可。
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。