yii2 使用 zircote/swagger-php 进行swagger 搭建

Posted 2020-10-19 to_simple

网站上关于中文介绍的博客许多东西千篇一律，而且讲的很多都浪费了我大量的时间。

然后就准备咬咬牙看看英语文档：

https://packagist.org/packages/zircote/swagger-php

进行网站进行搭建，使用的是yii2 2.0.12

 

使用composer 进行安装

composer require zircote/swagger-php

然后进行下载swagger-ui 这个主要进行一个swagger调试的客户端，没有进行后端的交互，他主要是通过一个json进行初始化工作

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

 

然后对这个里面的dist/index.html进行修改json文件的引用，我是将这个客户端放到一个独立的域名下，然后在yii中写入一个方法生成一个json

define(‘API_HOST‘,(YII_ENV === ‘dev‘)?‘new.rprise.wd.com‘:‘test.com‘);
$b2broot = Yii::getAlias(‘@rprise‘);
$swagger = \Swagger\scan($b2broot);
echo $swagger;exit;

然后将dist/index.html 文件指向这个文件路由

// Build a system
const ui = SwaggerUIBundle({
  url: "http://new.rprise.wd.com/user/genswg",　　　　//修改这个位置
  dom_id: ‘#swagger-ui‘,
  deepLinking: true,


为了避免误导大家，还是不多说了，最后还是希望大家还是多看看官方文档

　　https://github.com/zircote/swagger-php/blob/HEAD/docs/Getting-started.md　　//这里编写了代码的注释规范

 

　　看到一愣一愣的时候看看这个

　　https://bfanger.nl/swagger-explained/#schemaObject

 

一开始进行搭建代码生成可能会报错

比如

@SWG/info not fount 之类是因为没写注释，总之耐心，相信官网文档，有问题留言一下讨论