讲师中心 微信公众号
AI工具推荐 视频效率加速

Yii2.0.55 Swagger接口文档生成【API文档】

千伟同学_4926

千伟同学_4926

发布时间:2026-08-07 18:29:47

|

656人浏览过

|

来源于php中文网

原创

在Yii 2.0.55中生成可交互Swagger文档需手动引入swagger-php 3.0.4和doctrine/annotations,配置OpenAPI根注释(含@OA\Info、@OA\Server、@OA\Swagger),为接口添加@OA注解或YAML定义,执行命令生成swagger.json,并集成Swagger UI实现在线调试。

yii2.0.55 swagger接口文档生成【api文档】

在Yii 2.0.55项目中自动生成可交互的Swagger API文档,需绕过框架默认不支持注解解析的限制,手动引入swagger-php并配置命令行生成流程,确保文档与代码变更实时同步。

安装swagger-php与依赖

执行命令安装OpenAPI 3.0兼容的解析器:composer require zircote/swagger-php:3.0.4

必须同时安装Doctrine注解库,否则@OA\*注解无法被识别:composer require doctrine/annotations

【不装doctrine/annotations会导致所有注解被忽略,生成空json】

编写全局OpenAPI配置注释

api/controllers/SwaggerController.php或独立文件api/web/swagger.php顶部添加完整OpenAPI根配置。

注释中必须包含@OA\Info@OA\Server@OA\Swagger三组核心结构,缺一不可。

host字段要填实际部署域名(如api.example.com),不能写localhost,否则Swagger UI加载后请求会跨域失败。

为每个接口添加@OA注解

方法一:直接在action方法上方写注释
controllers/UserController.phpactionIndex()前插入:

/**
* @OA\Get(
* path="/v1/users",
* summary="获取用户列表",
* @OA\Response(response="200", description="成功")
*/

Yii Framework 2.0.51
Yii Framework 2.0.51

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

下载

方法二:集中写在单独文件
新建api/docs/openapi/user.yaml,用YAML格式定义接口,再通过swagger-php的--yaml参数加载。

注意:Yii路由规则(如'users' => 'user/index')不会被自动映射,@OA\Get中的path必须是最终对外暴露的真实路径,不是控制器方法名。

生成swagger.json文件

第一步:确认注释文件位置
将所有含@OA\*注释的PHP文件放在api/controllers/api/models/目录下。

第二步:执行生成命令
php vendor/bin/openapi api/controllers/ api/models/ -o api/web/swagger-docs/swagger.json

第三步:检查输出结果
打开生成的swagger.json,搜索"paths"字段,确认至少有一条接口路径存在;若为空,说明注释未被扫描到或语法错误。

第四步:验证JSON有效性
把文件拖入https://editor.swagger.io,红色报错即表示注解格式有误,常见问题是缺少@OA\Tag@OA\Response嵌套层级错位。

集成Swagger UI界面

下载最新版Swagger UI压缩包,解压后重命名为swagger-ui,放入api/web/目录。

修改api/web/swagger-ui/dist/index.htmlurl字段,指向"/swagger-docs/swagger.json"

访问http://your-domain/swagger-ui/dist/index.html,页面加载后应显示完整接口列表,点击任意接口可发起在线调试。

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

相关专题

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

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

504

2025.11.26

json数据格式
json数据格式

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

1955

2023.08.07

json是什么
json是什么

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

2602

2023.08.23

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

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

896

2023.10.13

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

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

2919

2025.09.10

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

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

2750

2025.09.04

NumPy常见函数使用方法
NumPy常见函数使用方法

本专题整理 NumPy 常见函数使用方法相关教程,覆盖函数大全、参数用法、数组运算、统计聚合、排序处理、where 条件筛选、linspace 创建数列等常用场景,帮助读者快速掌握 NumPy 函数调用思路和实际数据处理技巧。

0

2026.09.22

NumPy性能优化版本更新与常见报错排查
NumPy性能优化版本更新与常见报错排查

本专题整理 NumPy 性能优化、版本更新与常见报错排查相关教程,覆盖向量化计算、广播性能、内存布局、NumPy 2.0 升级、版本兼容冲突、安装导入报错、dtype 溢出、矩阵运算异常和 broadcasting 报错修复,帮助读者系统掌握 NumPy 性能调优与问题定位方法。

20

2026.09.22

Vibeknow在线使用入口合集
Vibeknow在线使用入口合集

本专题汇总了Vibeknow在线创作视频的官方入口及网页版使用教程,涵盖PPT、PDF、Word等文档一键转讲解视频的核心操作,并整理了免费版水印规则与手机端浏览器访问指南,助你快速将知识内容视频化。

20

2026.09.21

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Yii Framework 2.0 API 官方文档
Yii Framework 2.0 API 官方文档

共0课时 | 0人学习

Yii2.0框架开发实战视频教程
Yii2.0框架开发实战视频教程

共22课时 | 9.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn