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/php

图片描述

2. 修改成本身的项目文件。

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

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版本laravel

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文件从新覆盖便可。git

相关文章
相关标签/搜索