yii2 + swagger-php 新版详解快速构建 从此接口文档可以整合到项目中

这里是引用
swagger 其实是跨平台的产物,当然java中已经离不开它了。尤其是写接口直接注解可以变成接口文档。今天咱们用Yii2框架初步整合下,一边吐槽,一边快速实现下,开始:

首先 composer下来,-vvv可以展示完整下载信息。
composer require zircote/swagger-php -vvv

其次:
从GitHub上下载swagger-ui最新版本
① GitHub地址:https://github.com/swagger-api/swagger-ui
② 将下载的文件重名为swagger-ui,放在/api/web目录下,如图所示:

swagger-ui
通过上述操作可以清楚明白swagger-ui 其实是一个独立的UI,也可以理解为前端页面,而咱们下载的swagger-php负责接口注释的解析,它俩中间需要做个关联。

新建文件夹swagger-docs 如图所示。可以预先创建一个swagger.json空白文件。
修改swagger-ui/dist/index.html 2处注释地方即可

    <script>
    window.onload = function() {
   
      // Begin Swagger UI call region
      const ui = SwaggerUIBundle({
   
        url: "/swagger-docs/swagger.json", //修改此处 建立联系
        dom_id: '#swagger-ui',
        deepLinking: true,
        validatorUrl: null,//增加此参数 防止接口文档外网验证失败
        presets: [
          SwaggerUIBundle.presets.apis,
          SwaggerUIStandalonePreset
        ],
        plugins: [
          SwaggerUIBundle.plugins.DownloadUrl
        
  • 1
    点赞
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值