Yii2+Swagger自动生成API文档实战【规范】

大婷吖_6046

大婷吖_6046

2026-07-11

266人浏览

原创

yii2集成swagger需手动组合zircote/swagger-php与swagger ui:注解须写在public action上并含激活标记,路径须与实际url完全一致,资源须通过assetbundle发布,生成命令须显式指定目录。

yii2+swagger自动生成api文档实战【规范】

Yii2 本身不带 Swagger 功能,必须靠第三方工具组合实现:用 zircote/swagger-php 扫描注解生成 JSON,再用 Swagger UI 渲染页面。整个过程不自动、不智能,路径要手写、资源要手动发布、命令要显式执行——规范就体现在这些“必须做”的细节里。

注解必须写在 action 上,且 path 一字不差

Swagger-php 是静态扫描器,完全不读 Yii2 的 UrlManager 或路由规则。哪怕你配置了 'article/<id:>' => 'article/view'</id:>,注解里也得硬写:

  • @OA\Get(path="/api/v1/articles/123") —— 实际请求 URL 是什么,这里就写什么
  • 带后缀(如 .json)就得带上:/api/v1/users.json
  • 有模块前缀(如 v1)和 API 前缀(如 /api)都不能省
  • 参数只声明结构,不映射规则:@OA\Parameter(name="id", in="path", required=true, @OA\Schema(type="integer")) 就够了,不用写正则或占位符

控制器文件必须“激活”,注解才被识别

一个 PHP 文件里光有 @OA\Get 不够,还得有“激活标记”,否则 swagger-php 直接跳过该文件:

Yii Framework 2.0.51
Yii Framework 2.0.51

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

下载
  • 要么开头加 @OA\Info(title="My API", version="1.0")
  • 要么至少有一个 @OA\PathItem(比如配合 @OA\Get 一起出现)
  • 注解必须写在 public function actionIndex() 方法上方,不能写在方法内部,也不能写在 private 方法上
  • 如果控制器继承 yii\rest\ActiveController,别指望它自动推导接口——每个公开 action 都得单独加 @OA\Get/@OA\Post

资源必须走 AssetBundle,不能直接扔进 webroot

Swagger UI 的 JS/CSS 必须通过 Yii2 的资源管理机制发布,否则页面空白或报 SwaggerUIBundle is not defined:

  • 定义自定义 AssetBundle,$sourcePath 指向 vendor/swagger-api/swagger-ui/dist
  • 设 publishOptions['forceCopy'] = true,避免缓存导致旧版 JS 加载失败
  • 在布局文件 head 区域调用 SwaggerUiAsset::register($this)
  • F12 查 Network,确认 /assets/xxx/swagger-ui-bundle.js 返回 200;若 404,删掉 @web/assets 目录重试

生成命令必须指定目录,不能靠猜测

运行 php vendor/bin/openapi 时,不传路径就不会扫任何代码:

  • 正确示例:php vendor/bin/openapi --output docs/api.json api/controllers/ modules/v1/controllers/
  • 路径末尾不要加 * 或通配符,openapi 不支持 shell 展开,会当字面量处理
  • Yii2 Starter Kit 类项目常有 api/modules/v1/controllers 这种嵌套结构,漏掉就等于漏掉整版接口
  • 修改注解后必须重新运行命令,swagger.json 不会自动更新

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

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

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

下载

相关标签:

yii2 yii

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

相关专题

更多
PHP API接口开发与RESTful实践
PHP API接口开发与RESTful实践

本专题聚焦 PHP在API接口开发中的应用,系统讲解 RESTful 架构设计原则、路由处理、请求参数解析、JSON数据返回、身份验证(Token/JWT)、跨域处理以及接口调试与异常处理。通过实战案例(如用户管理系统、商品信息接口服务),帮助开发者掌握 PHP构建高效、可维护的RESTful API服务能力。

2025.11.26

524

16

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2023.08.07

2075

5

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.23

3102

1

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

2023.10.13

1056

3

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

2025.09.10

3519

7

PHP Yii框架专题
PHP Yii框架专题

本专题专注于PHP主流框架Yii的应用,系统讲解MVC架构、路由机制、数据库操作、表单处理、安全验证与RESTful API 开发等核心内容。通过电商网站、后台管理系统与内容管理平台等实战项目,帮助学员快速掌握Yii框架的开发技巧与实战经验。

2025.09.04

2970

22

PixTV官网入口地址合集
PixTV官网入口地址合集

本专题汇总了 PixTV AI 一站式视频创作平台的官方入口与使用教程。无需下载软件,浏览器直接访问即可使用。平台将剧本、图像、视频、声音与剪辑整合在“无限画布”中,接入 GPT Image 2.5、Seedance 2.5 等头部模型。本专题整理了从新建画布、角色锚定、分镜拆分到视频生成与导出的完整操作指南,助你快速上手 AI 短剧与漫剧创作。

2026.10.10

80

15

Kratos框架HTTP与gRPC服务开发教程
Kratos框架HTTP与gRPC服务开发教程

本专题围绕Kratos框架双协议服务开发,涵盖HTTP路由与处理器编写、参数获取、gRPC服务实现与客户端调用、metadata上下文传递、encoding编解码注册、统一响应封装、超时控制与流式响应实现方法。

2026.10.10

40

15

Kratos框架Protobuf接口定义与代码生成合集
Kratos框架Protobuf接口定义与代码生成合集

本专题讲解Kratos框架接口定义体系,涵盖proto编写规范、proto add/client/server生成命令、http注解路由、validate校验、OpenAPI文档生成、跨服务proto复用与兼容性设计。

2026.10.10

20

15

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Yii2中文手册
Yii2中文手册

共0课时 | 0.6万人学习

thinkphp基础介绍和yii2基础介绍
thinkphp基础介绍和yii2基础介绍

共10课时 | 2.5万人学习

Yii2框架基础视频教程
Yii2框架基础视频教程

共22课时 | 2.8万人学习