Swagger-PHP

swagger-php

官网传送门
安装
  • 安装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了,
    其次, 可以将生成的接口文件放在项目里,防止跨域问题(只推荐在测试服务器使用)
  • 如何引用将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

你可能感兴趣的