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

CodeIgniter框架怎么实现接口文档自动生成_CodeIgniter框架Swagger集成实战【实战】

夏磊小哥_2053

夏磊小哥_2053

发布时间:2026-05-04 08:42:47

|

219人浏览过

|

来源于php中文网

原创

Swagger在CodeIgniter中需手动集成注释扫描、JSON输出、UI渲染三步;必须用zircote/swagger-php^4.9支持PHP8+,注释以@OA\前缀、换行闭合,路径须为绝对目录,JSON响应头需设Content-Type: application/json,UI中url须为可访问的绝对API地址。

codeigniter框架怎么实现接口文档自动生成_codeigniter框架swagger集成实战【实战】

Swagger 在 CodeIgniter 中不是开箱即用的,必须手动集成注释扫描 + JSON 输出 + UI 渲染三步。直接装个包、加几行配置就想出文档,基本会卡在 openapi->toJson() 报空或路径找不到。

注释必须用 @OA\ 前缀,且依赖 zircote/swagger-php 4.x

CodeIgniter 3/4 都不自带 OpenAPI 解析器,swagger-php 是唯一能从 PHPDoc 提取结构化数据的主流工具。低版本(如 2.x)不支持 PHP 8+ 的属性语法,而 CI4 多数项目已升到 PHP 8.1+,所以必须用 composer require zircote/swagger-php:^4.9。注释写法示例:

/**
 * @OA\Info(title="User API", version="1.0.0")
 */
class Users extends RestController
{
    /**
     * @OA\Get(
     *     path="/api/users",
     *     summary="获取用户列表",
     *     @OA\Response(response="200", description="OK")
     * )
     */
    public function index_get()
    {
        // ...
    }
}

注意:@OA\ 不是 @SWG\(旧版 Swagger 2.0),也不支持 /** @OA\Info */ 这种单行写法——必须换行、必须完整闭合、类和方法注释都得有顶层 @OA\Info 或 @OA\OpenApi。

scan() 路径必须指向真实控制器文件,不能用 APPPATH 动态拼接

常见错误是写 \OpenApi\scan(APPPATH . 'controllers'),但 APPPATH 在 CI3 是 application/,在 CI4 是 app/,而 scan() 实际需要的是含 .php 后缀的绝对路径目录(比如 /var/www/myapp/app/Controllers)。更稳妥做法是硬编码或通过环境变量传入:

  • CI3:用 __DIR__ . '/../controllers'(假设 Swagger 控制器放在 application/controllers 同级)
  • CI4:用 APPPATH . 'Controllers',但要确认目录名是大写的 Controllers(非 controllers)
  • 扫描后若返回空对象,用 var_dump(glob($path . '/*.php')) 先验证路径下是否真有可读的 PHP 文件

JSON 输出必须设对 Content-Type,否则 Swagger UI 加载失败

生成的 JSON 接口(如 /api/docs)如果没加 header('Content-Type: application/json'),Swagger UI 会静默报 TypeError: Failed to fetch。这不是跨域问题,是响应头类型不匹配。同时注意:

CodeIgniter 4.7.0
CodeIgniter 4.7.0

CodeIgniter下载页提供 CodeIgniter 4.7.0 官方源码包,并整理框架安装、数据库配置与入门开发说明。

下载
  • 不要用 echo json_encode(...) 手动输出——$openapi->toJson() 已含格式化和转义
  • 避免在输出前有任何 echo、print 或空白字符,否则 JSON 会以 HTML 开头导致解析失败
  • CI4 的 ResourceController 默认会加 Content-Type: application/json,但普通 CI_Controller 不会,必须显式设置

Swagger UI 页面里的 url 必须是可公开访问的绝对路径

UI 页面(比如 views/swagger.php)中初始化 Swagger UI 的 JS 代码里,url 字段填的是后端 JSON 接口地址,不是本地文件路径:

const ui = SwaggerUIBundle({
  url: "https://api.example.com/api/docs",
  dom_id: '#swagger-ui',
})

这个地址必须满足两个条件:

  • 能被浏览器直接访问并返回合法 JSON(状态码 200,Content-Type 正确)
  • 与 UI 页面同域,或后端已配好 CORS(Access-Control-Allow-Origin: *)

很多人把 url 写成 /asset/swagger.json 或 ./swagger.json,结果 UI 显示 “Failed to load spec”,其实是请求被浏览器拦截或 404。最省事的调试方式:在浏览器新开标签页,直接访问那个 URL,看能不能看到一屏 JSON。

真正容易被忽略的是注释和代码的耦合深度——@OA\ 注释不是装饰器,它不参与运行时逻辑,但一旦控制器方法签名变更(比如参数名改了、新增了 public function show_get($id = null)),对应注释里的 @OA\Parameter 就必须同步更新,否则文档和实际接口就脱节了。没人会自动校验这个,只能靠开发流程卡点。

热门AI工具

更多
超级麦吉

一款通过数字员工协作完成调研、数据分析与文档制作的AI办公平台。

DeepSeek

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

WorkBuddy

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

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

豆包大模型

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

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

3469

2023.06.20

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2388

2023.07.25

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

1320

2023.08.02

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1278

2023.08.09

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

1396

2023.09.05

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2298

2023.09.20

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

3740

2023.09.20

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

17415

2023.09.22

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

120

2026.10.22

热门下载

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

精品课程

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

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