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

相關文章
相關標籤/搜索