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

Echo框架路由如何生成Swagger接口文档

夜静姑娘_1551

夜静姑娘_1551

发布时间:2026-10-28 09:41:49

|

357人浏览过

|

来源于php中文网

原创

Echo路由不自动生成Swagger文档,因swag仅静态扫描含@Router等注释的具名handler函数,不解析e.GET等运行时路由语句;需确保注释紧贴函数、路径格式匹配(如:id→{id})、结构体字段可导出且带json tag,并用echo-swagger.WrapHandler挂载/swagger/*any路由。

echo框架路由如何生成swagger接口文档

Echo 路由本身不生成 Swagger 文档,必须配合 swag 工具 + 正确注释 + 手动挂载路由才能在 /swagger/*any 下看到可交互文档。

为什么 Echo 的 e.GET 等路由不会自动出现在 Swagger UI 里

Swag 不解析 Echo 的路由注册语句(如 e.GET("/user/:id", handler)),它只扫描 Go 源文件中被注释标记的 handler 函数。即使你写了 e.GET("/users", getUsers),若 getUsers 函数上方没有 // @Router /users [get] 这类注释,swag init 就完全看不到这个接口。

  • Swag 是静态源码分析工具,不是运行时中间件,不 hook Echo 的路由树
  • 所有 @Router 注释里的路径必须和实际 Echo 路由一致(比如 Echo 用 /user/:id,注释就得写 @Router /user/{id} [get],注意 :id → {id})
  • 如果 handler 是闭包(如 e.GET("/ping", func(c echo.Context) error {...})),无法加注释 → 必须提取为具名函数

swag init 扫不到 Echo 接口的常见原因

执行 swag init 后 docs/swagger.json 中 "paths" 为空,大概率是扫描范围或注释格式出错。

Skill Weave Chains — 技能链路由引擎
Skill Weave Chains — 技能链路由引擎

开箱即用的技能链路由引擎。13 条预定义链覆盖搜索、开发、审查、MLOps、法律、创意等场景,三层路由架构(触发词→SAD反馈→DAG编排),recall@10=96.97%。配置驱动(chains.yaml),零代码扩展。pip install skill-weave-chains 一键安装。

下载
  • 没指定入口文件:swag init -g cmd/myapp/main.go 必须显式给出含 echo.New() 和路由注册的 main 文件
  • handler 分散在 internal/handler 或 pkg/api?得加 -d internal/handler -d pkg/api 多次指定目录
  • 注释没紧贴函数声明:func getUsers(c echo.Context) error { ... } 上方不能有空行,且必须是连续的 // @xxx 块
  • 用了未导出结构体(如 type user struct)或字段没 json: tag → @Success 200 {object} user 会失败或显示空 schema

如何让 /swagger/*any 正确加载 Echo 的文档

不同于 Gin,Echo 没有官方 echo-swagger v2 兼容包,需用社区维护的 github.com/swaggo/echo-swagger(注意不是 gin-swagger)。

  • 安装:go get github.com/swaggo/echo-swagger
  • 导入:import "github.com/swaggo/echo-swagger"(不是 v2 后缀)
  • 挂载路由:e.GET("/swagger/*any", echoSwagger.WrapHandler) —— 路径必须带 /*any,不能写成 /swagger/ 或 /docs/
  • 确保 docs/docs.go 已生成且已 import(如 import _ "./docs"),否则 WrapHandler 会 panic

路径参数、查询参数、请求体怎么写才被正确识别

Swag 对参数类型极其敏感,Echo 路由里用 :id,注释里必须转成 OpenAPI 格式 {id},且类型只能是基础类型。

  • 路径参数:// @Param id path int true "用户ID" ✅(不能写 int64 或 uuid.UUID)
  • 查询参数:// @Param name query string false "用户名" ✅(collectionFormat: multi 才支持 ?ids=1&ids=2)
  • 请求体:// @Param user body model.User true "用户信息",且 model.User 上方必须有 // @Model 注释
  • 响应数组:// @Success 200 {array} model.User ✅(不是 {object} []model.User)

最易忽略的一点:所有结构体字段必须首字母大写 + 带 json:"field_name" tag,否则 Swagger UI 里字段名为空、类型显示为 object。

相关文章

路由优化大师
路由优化大师

路由优化大师是一款及简单的路由器设置管理软件,其主要功能是一键设置优化路由、屏广告、防蹭网、路由器全面检测及高级设置等,有需要的小伙伴快来保存下载体验吧!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
超级麦吉

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

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

Laper
Laper Hot

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

WorkBuddy

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

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

DeepSeek

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

豆包大模型

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

立刻MV
立刻MV Hot

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

AionClaw
AionClaw Hot

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

相关专题

更多
Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

20

2026.10.28

Vite 如何搭配 Vue.js
Vite 如何搭配 Vue.js

Vite搭配Vue.js专题汇集创建Vue 3项目、配置开发环境、路径别名、Vue插件、代理、多环境构建与调试的已审核文章,帮助读者完成从初始化到日常开发的配置。

0

2026.10.28

Vite 项目目录怎么看
Vite 项目目录怎么看

Vite项目目录专题汇集入口文件、src源码、public静态资源、路径别名、项目根目录和构建输出目录相关的已审核文章,帮助读者理解各文件夹的用途与引用方式。

0

2026.10.28

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

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

120

2026.10.22

Gradle Wrapper配置教程
Gradle Wrapper配置教程

本专题介绍Gradle Wrapper的基本作用,涵盖文件组成、生成方法、版本配置和任务调用,帮助你理解项目如何使用指定的Gradle版本,减少不同开发环境带来的构建差异。

60

2026.10.22

Golangci-lint检查器使用教程
Golangci-lint检查器使用教程

本专题整理Golangci-lint常用Linters的用途与配置方法,覆盖错误处理、无效代码、安全、复杂度、命名和依赖检查,帮助项目合理选规则。

60

2026.10.22

Gradle怎么构建Java项目
Gradle怎么构建Java项目

本专题介绍Gradle Java项目构建方法,涵盖Java插件配置、依赖声明、源码编译、测试执行和打包检查,帮助你理解各阶段的任务关系,逐步完成项目构建。

40

2026.10.22

PHP时间戳漏洞修复教程
PHP时间戳漏洞修复教程

本专题汇总PHP常见时间戳漏洞,包括2038年溢出、时区漂移、时间戳伪造、重放攻击、时间盲注与日志审计失效等,并给出升级64位环境、使用 DateTimeImmutable、统一UTC、严格超时校验、预处理绑定、hash_equals 比对等修复方案,帮助开发者快速排查和加固时间相关代码。

60

2026.10.22

Golangci-lint配置文件与规则设置
Golangci-lint配置文件与规则设置

本专题聚焦Golangci-lint YAML配置文件,讲清运行参数、规则启停、目录排除、问题过滤及严重级别设置,便于团队统一检查标准。

20

2026.10.22

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Echo框架路由配置手册
Echo框架路由配置手册

共0课时 | 0人学习

Revel 官方开发手册
Revel 官方开发手册

共0课时 | 0人学习

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

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