swagger php修改成中文,swagger-php最简单的通用配置方式

首先、下载swagger-php包

在你的项目里安装composer(不过最好全局安装composer)

然后在你的项目任何位置,执行下面命令(Mac或Linux系统,window系统可以查看相应的composer命令)composer require zircote/swagger-php

我们使用的是zircote的swagger包

第二、生成接口文档(json格式)

包下载好之后,在当前目录执行以下命令php ./vendor/zircote/swagger-php/bin/swagger 需要生成接口文档的mvc目录  -o  接口文档生成位置

你也可以在你的mvc目录下,增加一个swagger-config.php配置文件(命名可修改),里面可以设置好基本配置(仅列出基本配置,详细配置请参考swagger文档)

此时你就可以在你项目的Controller文件中添加详细swagger接口注释了,每次修改完成之后,执行一下上面的命令即可生成接口文档json

第三、展示json

生成接口文档之后,就需要对外展示了,这里我们使用官方提供的swagger-ui,大家有兴趣也可以试试其他swagger-ui扩展,做的也不错。

在你项目对外访问的目录,执行下面命令git clone https://github.com/swagger-api/swagger-ui.git

执行完毕之后,你的项目就会有一个swagger-ui文件夹,修改文件夹中的dist/index.html第77行url: "/docs/swagger.json",

把url指向上面命令的  接口文档生成位置  即json生成位置

保存

打开浏览器,访问你的域名/swagger-ui/dist

这样就ok了。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值