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

Go语言swag如何格式_Go语言JSON文档展示【规范】

千枫酱_1332

千枫酱_1332

发布时间:2026-06-15 09:00:23

|

844人浏览过

|

来源于php中文网

原创

swag本身不负责JSON格式化展示,只生成紧凑格式的swagger.json和swagger.yaml;其单行设计源于使用json.Marshal而非MarshalIndent,旨在减小体积、提升加载速度,且不支持命令行开启缩进;需借助jq等外部工具手动美化,或确保@exemple注释提供合法JSON字符串以触发Swagger UI自动pretty-print。

go语言swag如何格式_go语言json文档展示【规范】

swag 本身不负责 JSON 文档的“格式化展示”,它只生成 swagger.json(紧凑格式)和 swagger.yaml。你看到的带缩进、可读的 JSON 页面,是 Swagger UI 渲染时做的美化,不是 swag 输出的——这点容易搞混。

swag init 生成的 swagger.json 为什么是单行?

这是设计使然:swag init 调用的是 Go 的 json.Marshal(非 MarshalIndent),目的是减小文件体积、加快加载速度,尤其对大型 API 文档更关键。

  • 它不支持通过命令行参数开启缩进输出;--output 只控制路径,不控制格式
  • 即使你手动用 json.MarshalIndent 重写 docs/docs.go 中的 SwaggerJSON 变量,下次 swag init 就会被覆盖
  • 想保留缩进?只能在生成后用外部工具处理,比如:jq '.' docs/swagger.json > docs/swagger.pretty.json

如何让 Swagger UI 展示时自动格式化 JSON 示例?

Swagger UI 默认会对请求/响应体中的 JSON 示例做 pretty-print,但前提是你的 @example 注释里给的是合法 JSON 字符串(不是 Go 字面量)。

Json Schema Toolkit
Json Schema Toolkit

使用 JSON Schema 验证 JSON 数据,从示例 JSON 生成 schema,并将其转换为 TypeScript 接口、Python 数据类或 Markdown 文档。

下载
  • 错误写法:@example json {Name: "foo", Age: 25} → UI 会原样显示,不解析、不缩进
  • 正确写法:@example json {"name":"foo","age":25} → UI 自动加缩进和语法高亮
  • 注意双引号必须是英文、不能有尾随逗号、布尔值小写(true,不是 True)
  • 如果示例含换行或特殊字符,用 \n 和 \" 转义,否则注释解析失败

自定义 JSON 响应结构体字段名时,swag 怎么映射?

swag 解析结构体字段靠的是 Go 的导出规则 + json: tag,但它**不执行运行时反射**,只做静态 AST 分析。

立即学习“go语言免费学习笔记(深入)”;

  • 字段必须首字母大写(如 Name),否则 swag 完全忽略
  • json:"user_name" → 文档中显示为 user_name;json:"-" → 字段不出现在文档中
  • json:",omitempty" 不影响字段是否出现在 schema 中,只影响运行时序列化逻辑
  • 嵌套结构体同理:每一层都得导出 + 有对应 tag,否则字段名回退到 Go 名(如 UserDetail → userDetail,取决于 --propertyStrategy)
  • 别指望 json:"id,string" 这类编码 hint 被 swag 识别——它只认字段名映射,不处理编解码行为

真正容易被忽略的是:swag 的注释解析器对 Go 语法非常敏感。一个多余的括号、少一个引号、或者用了未声明的类型别名,都会导致整个 handler 的文档丢失,且不报错——只能靠肉眼检查 swag init -v 的输出日志。

热门AI工具

更多
DeepSeek

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

PixPix
PixPix Hot

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

AionClaw
AionClaw Hot

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

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

UP简历
UP简历 Hot

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

豆包大模型

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

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

WorkBuddy

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

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

相关专题

更多
Golang 入门学习路线:从零基础到上手开发
Golang 入门学习路线:从零基础到上手开发

Golang 入门路线涵盖从零到上手的核心路径:首先打牢基础语法与切片等底层机制;随后攻克 Go 的灵魂——接口设计与 Goroutine 并发模型;接着通过 Gin 框架与 GORM 深入 Web 开发实战;最后在微服务与云原生工具开发中进阶,旨在培养具备高性能并发处理能力的后端工程师。

186

2026.02.24

Golang 疑难杂症解决指南:常见问题排查与优化
Golang 疑难杂症解决指南:常见问题排查与优化

《Golang 疑难杂症解决指南》聚焦开发过程中常见却棘手的问题,从并发模型、内存管理、性能瓶颈到工程化实践逐步拆解。通过真实案例与调试思路,帮助开发者定位问题根因,建立系统化排查方法。不只给出答案,更强调分析路径与工具使用,让你在复杂 Go 项目中具备持续解决问题的能力。

113

2026.02.24

Golang 运行与部署实战:从本地到云端
Golang 运行与部署实战:从本地到云端

《Golang 运行与部署实战》围绕 Go 应用从开发完成到稳定上线的完整流程展开,系统讲解编译构建、环境配置、日志与配置管理、容器化部署以及常见运维问题处理。结合真实项目场景,拆解自动化构建与持续部署思路,帮助开发者建立可靠的发布流程,提升服务稳定性与可维护性。

617

2026.02.24

Golang 面试题精选:高频问题与解答
Golang 面试题精选:高频问题与解答

Golang 面试题精选》系统整理企业常见 Go 技术面试问题,覆盖语言基础、并发模型、内存与调度机制、网络编程、工程实践与性能优化等核心知识点。每道题不仅给出答案,还拆解背后的设计原理与考察思路,帮助读者建立完整知识结构,在面试与实际开发中都能更从容应对复杂问题。

198

2026.02.24

Golang 性能优化专题:提升应用效率
Golang 性能优化专题:提升应用效率

《Golang 性能优化专题》聚焦 Go 应用在高并发与大规模服务中的性能问题,从 profiling、内存分配、Goroutine 调度、GC 机制到 I/O 与锁竞争逐层分析。结合真实案例讲解定位瓶颈的方法与优化策略,帮助开发者建立系统化性能调优思维,在保证代码可维护性的同时显著提升服务吞吐与稳定性。

437

2026.02.24

Golang 生态工具与框架:扩展开发能力
Golang 生态工具与框架:扩展开发能力

《Golang 生态工具与框架》系统梳理 Go 语言在实际工程中的主流工具链与框架选型思路,涵盖 Web 框架、RPC 通信、依赖管理、测试工具、代码生成与项目结构设计等内容。通过真实项目场景解析不同工具的适用边界与组合方式,帮助开发者构建高效、可维护的 Go 工程体系,并提升团队协作与交付效率。

168

2026.02.24

Golang 并发编程专题:掌握多核时代的核心技能
Golang 并发编程专题:掌握多核时代的核心技能

《Golang 并发编程专题:掌握多核时代的核心技能》系统讲解 Go 在并发领域的设计哲学与实践方法,深入剖析 goroutine、channel、调度模型与并发安全机制,结合真实场景与性能思维,帮助开发者构建高吞吐、低延迟、可扩展的并发程序,全面提升多核时代的工程能力。

524

2026.02.26

Golang Web 开发路线:构建高效后端服务
Golang Web 开发路线:构建高效后端服务

《Golang Web 开发路线:构建高效后端服务》围绕 Go 在后端领域的工程实践,系统讲解 Web 框架选型、路由设计、中间件机制、数据库访问与接口规范,结合高并发与可维护性思维,逐步构建稳定、高性能、易扩展的后端服务体系,帮助开发者形成完整的 Go Web 架构能力。

205

2026.02.26

PixTV AI视频生成与无限画布创作
PixTV AI视频生成与无限画布创作

PixTV专题整理AI视频与视觉内容创作相关功能使用教程,涵盖AI生图、视频生成、无限画布、多模型创作、素材管理、声音音乐及视频剪辑等功能,帮助用户快速掌握PixTV从创意到成片的完整制作方法。

0

2026.09.29

热门下载

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

精品课程

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

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