讲师中心 微信公众号

工具推荐

视频效率加速
剧云
剧云

中文短剧剧本制作平台

立刻MV
立刻MV

低成本歌曲 MV、视频生成

AniShort
AniShort

AI短剧协同制作平台

SoundView
SoundView

字幕擦除翻译、配音口型同步

Go-Zero框架怎么对接Swagger?接口文档自动生成

老丽大大_6836

老丽大大_6836

发布时间:2026-11-22 15:48:21

|

342人浏览过

|

来源于php中文网

原创

go-zero 对接 swagger 并自动生成接口文档,核心做法是在 go.mod 中引入 github.com/zeromicro/go-zero 依赖,并在代码中使用 goctl api go -c 命令生成带有 swagger 注解的 go 代码。这样生成的代码在启动时会自动解析注释,通过内置的 http 服务暴露 /swagger/json 接口,前端页面则通过 /swagger/web 访问。

Go-Zero框架怎么对接Swagger?接口文档自动生成

如何配置 goctl 生成带注解的代码

使用 goctl api go -c 命令是生成兼容 Swagger 代码的标准方式。该命令会扫描 .api 文件,根据其中的路由定义和结构体标签,自动在生成的 .go 文件中插入 @doc、@summary 等 Swagger 标准注解。开发者只需确保 API 定义文件中的字段描述清晰,即可实现文档内容的自动化填充。

Go-Zero框架怎么对接Swagger?接口文档自动生成

module myapp

go 1.20

require github.com/zeromicro/go-zero v2.3.1

假设有一个 user.api 文件:

type UserRequest {
    Name string `json:"name"` // 用户姓名
}

service user-api {
    @handler CreateUser
    post /user/create (UserRequest) returns (UserResponse)
}

执行以下命令生成代码:

Go-Zero 1.9.1
Go-Zero 1.9.1

Go-Zero 1.9.1 源码包下载,提供日志键名定制、SSE 稳定性修复、慢写检测和运行诊断优化。

下载
goctl api go -api user.api -dir . -c

生成的代码中将包含如下注释:

// @title User API
// @version 1.0
// @description User management service
// @host localhost:8080
// @BasePath /

// CreateUser godoc
// @Summary Create a new user
// @Description Create a new user with name
// @Accept json
// @Produce json
// @Param body body UserRequest true "User info"
// @Success 200 {object} UserResponse
// @Router /user/create [post]

如何在项目中启用 Swagger 服务

在生成的代码中,Swagger 服务通常由框架内部自动注册。开发者需要在 main.go 或启动逻辑中确保服务器正常启动。Go-Zero 的 rest.Server 会在启动时自动挂载 Swagger 相关的路由。无需额外编写路由代码,只需关注业务逻辑的实现。

Go-Zero框架怎么对接Swagger?接口文档自动生成

package main

import (
    "flag"
    "net/http"
    "github.com/zeromicro/go-zero/core/service"
    "github.com/zeromicro/go-zero/rest"
)

var port = flag.Int("port", 8888, "server port")

func main() {
    flag.Parse()

    s := rest.MustNewServer(rest.RestConf{
        Port: *port,
    })
    defer s.Stop()

    // 这里通常会调用 handler 注册路由
    // 例如:RegisterHandlers(s, ...)
    
    // Swagger 路由已自动注册
    // GET /swagger/json -> 返回 JSON 文档
    // GET /swagger/web -> 返回 HTML 页面

    fmt.Printf("Starting server at %s:%d\n", "0.0.0.0", *port)
    s.Start()
}

启动服务后,访问 http://localhost:8888/swagger/web 即可看到 Swagger UI 界面。如果希望自定义 Swagger 信息(如标题、版本),可以在 .api 文件的头部添加全局注释,或者在生成的代码中手动修改顶部的 @title 等注解。

Swagger 文档中如何处理自定义响应结构

当接口返回的结构体包含非标准类型或需要特殊说明时,Swagger 文档可能无法准确展示其含义。此时需要在 .api 文件中为结构体字段添加详细的注释,并确保生成的代码保留了这些注释。对于复杂的嵌套结构,建议在 API 定义中明确每个字段的类型和约束,以便 Swagger 能够正确解析并生成对应的 JSON Schema。

热门AI工具

更多
切问学术

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

WorkBuddy

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

SkildArt
SkildArt Hot

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

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

DeepSeek

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

SoundView
SoundView Hot

SoundView是一款面向跨境电商的视频翻译、配音和本地化 AI 创作平台。

UP简历
UP简历 Hot

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

笔灵降AI

一款AI论文写作工具,主要用于论文降AI神器,适配知网及维普!一键降至安全线,100%保留原文格式;无口语化问题,文风更学术,降后字数控制最佳!,适合需要提升相关任务效率的用户。

豆包大模型

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

相关专题

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

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

246

2026.02.24

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

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

153

2026.02.24

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

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

697

2026.02.24

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

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

258

2026.02.24

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

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

537

2026.02.24

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

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

248

2026.02.24

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

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

624

2026.02.26

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

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

265

2026.02.26

CVE-2026-114938高危漏洞修复
CVE-2026-114938高危漏洞修复

Java4Shell是OpenJDK Base64解码路径中的远程代码执行漏洞,编号CVE-2026-114938,2026年11月17日披露,官方已发布17.0.21.1、21.0.13.1等修复版本,建议优先升级 。本专题围绕Java4Shell(CVE-2026-114938)持续更新,从漏洞原理、受影响版本、受影响产品到修复与自查一站式汇总,适合Java开发、运维与安全人员快速定位风险。ARM64环境不受影响,x86-64环境请

0

2026.11.22

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Go-Zero框架快速开始指南
Go-Zero框架快速开始指南

共0课时 | 0人学习

Go-Zero HTTP服务开发指南
Go-Zero HTTP服务开发指南

共0课时 | 0人学习

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

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