PHP 安装swagger文档api

1. 安装前端

git clone https://github.com/swagger-api/swagger-ui.git

http://localhost/yii2/swagger-ui/dist/index.html    打开URL就可以看到前端界面了(内容还是默认的)

之后找到dist目录, 打开index.html把其中的那一串url改成自己的, 比如http://localhost/yii2/swagger-docs/swagger.json(文件是通过下面的步骤生成的

2. 安装后端

composer require zircote/swagger-php

php ./vendor/zircote/swagger-php/bin/swagger 需要生成接口文档的mvc目录  -o  接口文档生成位置

注意:老版本是/vendor/zircote/swagger-php/bin/swagger

           新版本是/vendor/zircote/swagger-php/bin/openapi

"-o" 前面代表API源目录, 即你想要生成哪个目录的API文档, 你的项目代码目录. "-o" 后面是生成到哪个path

目标目录会产生一个swagger.json 或 openapi.yaml 文件,这个文件放到前端dist/index.html中可以访问的地方即可()

然后再看http://localhost/yii2/swagger-ui/dist/index.html, 生成了API文档

准备工作都做好了, 那就写代码注释就行了, 注释怎么写? 参考官方文档http://zircote.com/swagger-php/annotations.html

---------------------------------------------------------------------------------------------------------------------------------

可能出现的问题:

1、Could not open input file: composer.phar

解决:php -r "readfile('https://getcomposer.org/installer');" | php

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值