第一步:创建环境
进入入队的网站跟目录,创建swagger文件夹,然后再初始化composer.
mkdir swagger
composer init
第二步:拉取项目
将下面两个项目拉取下来,然后再利用composer 安装swagger-php的依赖。其中swagger-ui是前端渲染项目,swagger-php是用于抓取你项目注释的工具,
swagger-ui:https://github.com/swagger-api/swagger-ui
swagger-php:https://github.com/zircote/swagger-php
git clone https://github.com/swagger-api/swagger-ui
git clone https://github.com/zircote/swagger-php
进入 swagger-php文件夹下执行下面命令:
composer require zircote/swagger-php
这时你会发现swagger里多一个vendor的文件夹,这个就是需要的依赖,里面有生成文档的得例子
位置:\vendor\zircote\swagger-php\Examples\example-object
第三步:生产注释文档
测试swagger-php是否可以生成注释的文档
创建2个文件:mkdir test docs
把\vendor\zircote\swagger-php\Examples\example-object\example-object.php 拷贝到test文件夹下并修改
执行生成文件的命令:
php ./swagger-php/bin/openapi ./test -o ./docs
若无报错会生成一个文件:openapi.yaml !
这是文档已经生成接下来就是看如何渲染的啦啦啦
注:./test 需要扫描的文件 ,./docs 存放生成文档的位置
第四步:ui渲染
刚克隆下来的swagger项目打开是这样的:
打开刚刚下载的swagger-ui项目找到index.html文件:
把url替换成刚刚我们生成的openapi.yaml的请求连接(http://localhost/swagger/docs/openapi.yaml) 保存
然后通过刚刚安装的项目路径打开swagger-ui项目:
这时你已经看到我们前面写写的“”测试啦啦啦啦“” 字体,说明我们的安装已经完成啦!!!