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

如何在CodeIgniter中使用Swagger_CodeIgniterAPI文档生成【文档】

星丽小哥_7148

星丽小哥_7148

发布时间:2026-05-12 18:36:52

|

988人浏览过

|

来源于php中文网

原创

CodeIgniter需手动集成zircote/swagger-php^4.9实现Swagger文档生成,因框架本身不支持;scan()路径必须为含.php的绝对目录(非APPPATH拼接),注释须用@OA\前缀、换行闭合且含@OA\Info,JSON响应头必须设Content-Type: application/json,UI中url须为可访问的绝对地址。

如何在codeigniter中使用swagger_codeigniterapi文档生成【文档】

CodeIgniter 本身不提供 Swagger 文档生成功能,必须手动集成 zircote/swagger-php 并配合自定义控制器输出 JSON,否则访问 /api/docs 会 404 或返回空对象、TypeError: Failed to fetch。

为什么 swagger\scan() 返回空或报路径错误

根本原因是 scan() 接收的是「含 .php 后缀的绝对文件路径目录」,不是 CodeIgniter 的逻辑路径常量(如 APPPATH)拼接结果。CI3 和 CI4 的目录结构差异进一步放大这个问题:

  • CI3 中控制器通常在 application/controllers/,但 APPPATH 指向 application/,所以应传 APPPATH . 'controllers'(注意结尾无斜杠)
  • CI4 中默认是 app/Controllers(首字母大写),而 APPPATH . 'Controllers' 才对;若用小写的 controllers,glob($path . '/*.php') 就扫不到任何文件
  • 更稳妥做法是用 __DIR__ . '/../app/Controllers'(CI4)或 __DIR__ . '/../application/controllers'(CI3),避免依赖常量解析逻辑
  • 务必先用 var_dump(glob($path . '/*.php')) 验证路径下是否有可读的控制器文件——这是最常被跳过的调试步骤

@OA\ 注释写法必须严格符合 PHP8+ 规范

旧版 @SWG\ 已废弃,且 zircote/swagger-php ^4.9(PHP8.1+ 必选)不支持单行注释或不闭合写法:

CodeIgniter 4.7.0
CodeIgniter 4.7.0

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

下载
  • 顶层必须有 @OA\Info 或 @OA\OpenApi,不能只在方法里写 @OA\Get
  • 注释块必须换行闭合,/** @OA\Info(title="API") */ 这种单行写法会被忽略
  • 类和方法注释都要存在:控制器类上放 @OA\Info,每个 API 方法上放 @OA\Get/@OA\Post 等
  • 参数类型要显式声明,比如 @OA\Parameter(name="id", in="path", required=true, @OA\Schema(type="integer")),漏掉 @OA\Schema 会导致字段不显示

JSON 响应头和 UI 加载失败的直接原因

Swagger UI 不是靠 CORS 或网络连通性判断加载成败,而是严格校验响应头中的 Content-Type:

  • 生成 JSON 的控制器方法中,必须在 echo $openapi->toJson() 前加 header('Content-Type: application/json');
  • 如果用了 CodeIgniter 的 $this->output->set_content_type(),要确认它没被后续逻辑覆盖(比如某些钩子或输出缓存)
  • UI 页面中配置的 url 必须是可直接浏览器访问的绝对地址,例如 https://api.example.com/api/docs.json,不能是相对路径或 localhost 地址(跨域环境会静默失败)
  • 不要把 swagger.json 放到 public/ 下再用 Nginx alias 指向——动态生成的内容必须走 PHP 路由,否则注释变更后不会实时更新

最容易被忽略的是:CI4 的自动路由可能把 /api/docs 当成资源请求拦截了,得在 app/Config/Routes.php 里显式排除或配成 $routes->get('api/docs', 'Docs::index');;还有就是开发时习惯用 die() 调试,一不小心就卡在中间没输出 JSON,UI 就一直转圈。

热门AI工具

更多
WorkBuddy

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

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

UP简历
UP简历 Hot

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

二狗PPT
二狗PPT Hot

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

DeepSeek

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

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

豆包大模型

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

VibeKnow
VibeKnow Hot

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

相关专题

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

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

10484

2023.09.01

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

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

6161

2023.10.11

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

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

2115

2023.10.11

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

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

3888

2023.10.23

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

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

4594

2023.10.23

html怎么上传
html怎么上传

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

3591

2023.11.03

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

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

5137

2023.11.09

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

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

4022

2023.11.13

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

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

40

2026.10.10

热门下载

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

精品课程

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

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