Yii框架RESTful接口怎么生成文档_Yii框架Swagger集成步骤【解答】

陌宇大大_8912

陌宇大大_8912

2026-05-01

501人浏览

原创

yii框架集成swagger需第三方扩展、手动注解和静态资源发布三者协同:注解须写在方法上方并用@oa\info等激活文件,路径须硬编码匹配实际请求url,swagger ui资源须通过自定义assetbundle强制发布。

yii框架restful接口怎么生成文档_yii框架swagger集成步骤【解答】

Yii 框架本身不自带 Swagger 文档生成功能,必须靠第三方扩展 + 手动注解 + 静态资源发布三者协同才能跑通。光装包、光写注解、光配路由,任意一环断掉都会导致页面空白、404、JSON 生成失败或路径错乱。

zircote/swagger-php 注解必须写在方法上方,且文件要被“激活”

Swagger-php 是静态扫描工具,不会运行 Yii 的类或路由逻辑。它只认 PHP 文件里有没有以 @OA\Info、@OA\PathItem 等开头的注解——没有这类“根注解”,整个文件会被跳过。

  • 控制器方法前必须加 @OA\Get / @OA\Post 等动作注解,不能只依赖 yii\rest\ActiveController 的自动映射
  • 注解必须写在 public function actionIndex() 这一级,不能塞进 actions() 数组里,也不能写在方法体内
  • 如果把注解单独抽到 api/controllers/swagger.php 这类非控制器文件中,得确保 php vendor/bin/openapi 命令显式扫到它,例如:php vendor/bin/openapi --output docs/api.json api/controllers/ api/controllers/swagger.php
  • PHP 版本低于 5.4?别用 [] 写数组,改用 array(),否则注解解析直接静默失败

路径必须硬编码,和 Yii2 的 UrlManager 完全无关

Swagger-php 不读 rules,不看模块嵌套,不解析 <id:></id:> 路由规则。所有 path 值必须是最终请求时浏览器实际发出的 URL,一个字符都不能差。

Yii Framework 2.0.51
Yii Framework 2.0.51

Yii Framework 2.0.51 官方 Basic 应用模板,适合旧项目兼容、升级验证和开发测试。

下载
  • @OA\Get(path="/v1/users") 就只能匹配 GET /v1/users,不能写成 /users 指望框架补前缀
  • 若配置了 'suffix' => '.json',路径就得写成 /v1/users.json,否则文档里的路径和真实接口对不上
  • 参数绑定如 <id:></id:> 在路由中生效,但 Swagger 注解里只需声明 @OA\Parameter(name="id", in="path", required=true, @OA\Schema(type="integer")),不用管正则
  • 模块路径如 api/modules/v1/controllers/UserController,对应 URL 是 /v1/users,不是 /api/v1/users —— 前缀取决于 UrlManager 配置,你得自己确认并写死

Swagger UI 静态资源必须手动发布,不能靠 @webroot 直接扔进去

直接把 swagger-ui/dist 整个目录丢进 @webroot 是最常见翻车点:Yii2 的 AssetBundle 机制会拦截请求,未注册的资源路径一律 404。

  • 必须定义自定义 AssetBundle,$sourcePath 指向 vendor/swagger-api/swagger-ui/dist
  • 加上 publishOptions['forceCopy'] = true,避免因缓存导致 JS/CSS 未更新
  • 在布局文件(如 @app/views/layouts/main.php)的 区域调用 SwaggerUiAsset::register($this),否则控制台报 SwaggerUIBundle is not defined
  • F12 查 Network,确认 /assets/xxx/swagger-ui-bundle.js 返回 200;若 404,删掉 @web/assets 目录再刷新一次

生成命令必须显式指定源码目录,别信“自动发现”

php vendor/bin/openapi 默认只扫当前目录,不递归,也不识别 Yii2 的命名空间结构。不指定路径,大概率生成空 JSON 或只扫到部分文件。

  • 正确命令示例:php vendor/bin/openapi --output docs/api.json api/modules/v1/controllers/ api/controllers/
  • 如果用了多模块(如 v1、v2),每个模块路径都要列出来,不能只写 api/modules
  • 输出路径 docs/api.json 必须可写,且 Web 服务器能通过 HTTP 访问到(比如放在 @web/docs/api.json)
  • 生成后检查 JSON 是否合法:用在线校验器或 jq .info.title docs/api.json 看是否能读出字段;若报错,八成是某处注解语法错误(比如少了个括号、引号没闭合)

最容易被忽略的是注解与路由的“双重维护”:每次改 UrlManager 规则或模块结构,Swagger 注解里的 path 就得同步改。没人能绕过这点,也没人能靠工具自动推导——因为那不是静态分析能做到的事。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

yii框架 yii

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

10584

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

6201

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2115

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

3908

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4614

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3631

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

5177

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

4062

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

12002

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Yii2.0框架开发实战视频教程
Yii2.0框架开发实战视频教程

共22课时 | 9.3万人学习

Yii Framework 2.0 API 官方文档
Yii Framework 2.0 API 官方文档

共0课时 | 0人学习