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

最新推荐文章于 2024-08-24 09:57:03 发布

gufengbiaoying

最新推荐文章于 2024-08-24 09:57:03 发布

阅读量1.2k

点赞数 1

分类专栏： yii2 swagger swagger-php

本文链接：https://blog.csdn.net/gufengbiaoying/article/details/107022717

版权

本文介绍了如何在Yii2框架中整合swagger-php，通过注解方式生成接口文档。首先通过composer安装swagger-php，然后下载swagger-ui并放置于项目目录。尽管PHP需要手动运行命令生成swagger-json文件，但通过配置可以访问接口生成文档。接口描述和注释可以通过专门的php文件或直接在接口上编写。文章中还提到了一些遇到的问题，如虚拟机环境下文件缓存导致的json更新问题。

摘要由CSDN通过智能技术生成

这里是引用
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 其实是一个独立的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