swagger-php
官網(wǎng)傳送門
安裝
- 安裝swagger-php sdk,我這里是composer
composer require zircote/swagger-php
- 安裝swagger-ui
git clone https://github.com/swagger-api/swagger-ui.git
cd swagger-ui
npm install
- 配置swagger-ui訪問地址
- php輸出接口文件命令
php vendor/zircote/swagger-php/bin/openapi ./app/Http/Controllers/Finance/ -o swagger-ui磁盤目錄/swagger-ui/dist/
- 訪問配置swagger的域名/dist/#/
- 可以明確看到中間的輸入框,可以通過url的方式解析接口文件
安裝講解
- swagger-php 只能生成json或yaml格式的接口文件,需要通過swagger-ui前端框架進行展示
- 通常將swagger-ui 放到和項目入口文件所在文件目錄, 這樣就可以使用相同的域名進行訪問接口, 這樣就不用單獨配置nginx了,
其次, 可以將生成的接口文件放在項目里,防止跨域問題(只推薦在測試服務(wù)器使用) - 如何引用將swagger-php的注解文件, CLI模式下,
php vendor/zircote/swagger-php/bin/openapi 注解文件.php 指定的注解文件 -o ..
參考文檔:
Swagger-PHP Git 地址
Swagger-PHP v3.x
Swagger-PHP V1.x
Swagger-PHP v3.x
