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

如何在 Swagger UI 中正确声明字符串数组以避免逗号分隔的字符串问题

老浩吖_5568

老浩吖_5568

发布时间:2026-10-14 09:29:08

|

778人浏览过

|

来源于php中文网

原创

如何在 Swagger UI 中正确声明字符串数组以避免逗号分隔的字符串问题

Swagger UI 默认将表单中多个同名字段(如 nm_file)合并为逗号分隔的单个字符串;要真正传递字符串数组,需明确使用 type="array" + @OA\Items(type="string"),并确保前端以多值方式提交(如 nm_file[]=a&nm_file[]=b),而非拼接字符串。

swagger ui 默认将表单中多个同名字段(如 nm_file)合并为逗号分隔的单个字符串;要真正传递字符串数组,需明确使用 type="array" + @oa\items(type="string"),并确保前端以多值方式提交(如 nm_file[]=a&nm_file[]=b),而非拼接字符串。

在 OpenAPI 3.0(通过 swagger-php 注解实现)中,定义 multipart/form-data 请求体中的字符串数组时,关键在于语义准确性和传输协议一致性。你遇到的 nm_file = "string_a,string_b" 问题,并非 Swagger UI 渲染错误,而是后端实际接收到的表单数据格式所致——浏览器原生 <form></form> 提交多个同名 <input name="nm_file"> 时,若未使用 name="nm_file[]" 语法,服务端(如 PHP)通常会将其自动合并为逗号分隔字符串。

✅ 正确做法如下:

  1. OpenAPI 注解应严格声明为字符串数组(无需 object 包裹):

    @OA\Property(
     description="nama file",
     property="nm_file",
     type="array",
     @OA\Items(type="string") // ← 核心:直接声明 items 为 string 类型
    ),
  2. 前端提交必须使用数组式命名(尤其在 Swagger UI Try-it-out 中):

    • ✅ 正确(生成独立表单项):nm_file[]=string_a 和 nm_file[]=string_b
    • ❌ 错误(被合并):两个 nm_file=string_a 和 nm_file=string_b(无 [])
  3. 完整 multipart/form-data 示例注解:

    @OA\RequestBody(
     @OA\MediaType(
         mediaType="multipart/form-data",
         @OA\Schema(
             @OA\Property(
                 description="nama file",
                 property="nm_file",
                 type="array",
                 @OA\Items(type="string", example="report.pdf")
             ),
             @OA\Property(
                 description="file upload",
                 property="file[]", // 注意:PHP 风格命名,Swagger UI 支持
                 type="array",
                 @OA\Items(type="string", format="binary")
             )
         )
     )
    )

⚠️ 注意事项:

  • property="file[]" 是兼容 PHP 的写法,但 OpenAPI 规范中推荐使用 property="file" + type="array";Swagger UI 会自动处理 [] 后缀。
  • 若后端为 Laravel/Symfony 等框架,确保路由/控制器能正确解析 nm_file 为数组(如 Laravel 中 $request->get('nm_file') 返回 ['string_a', 'string_b'])。
  • 不要误用 @OA\Items(type="object") 包裹字符串——这会导致 Swagger 生成嵌套对象结构(如 [{"someString":"a"}]),与需求不符。

总结:字符串数组的本质是 type="array" + @OA\Items(type="string"),配合前端多值提交机制。Swagger UI 的渲染依赖于规范声明,而非后端行为;务必校验实际 HTTP 请求载荷(如浏览器 DevTools → Network),确认 nm_file 字段是否以多个独立参数形式发送。

热门AI工具

更多
DeepSeek

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

Loomy
Loomy Hot

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

SkildArt
SkildArt Hot

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

Laper
Laper Hot

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

UpDream
UpDream Hot

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

WorkBuddy

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

VibeKnow
VibeKnow Hot

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

豆包大模型

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

二狗PPT
二狗PPT Hot

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

相关专题

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

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

524

2025.11.26

json数据格式
json数据格式

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

2075

2023.08.07

json是什么
json是什么

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

3102

2023.08.23

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

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

1056

2023.10.13

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

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

3539

2025.09.10

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

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

80

2026.10.10

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

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

40

2026.10.10

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

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

20

2026.10.10

C++虚函数怎么定义和调用
C++虚函数怎么定义和调用

C++虚函数是实现运行时多态的重要机制。本专题从virtual关键字的基本用法入手,介绍基类与派生类之间的函数重写、基类指针调用派生类方法,以及动态绑定的执行过程,帮助初学者掌握虚函数的核心语法。

40

2026.10.10

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP基础入门课程
PHP基础入门课程

共33课时 | 3.4万人学习

Go语言教程-全程干货无废话
Go语言教程-全程干货无废话

共100课时 | 17.8万人学习

走进 ES6 新标准语法
走进 ES6 新标准语法

共15课时 | 2万人学习

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

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