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

Echo框架路由怎么配合Swagger生成接口文档

星婷大大_2542

星婷大大_2542

发布时间:2026-11-03 07:29:20

|

217人浏览过

|

来源于php中文网

原创

必须调用 echoSwagger.WrapHandler 并注册为 e.GET("/swagger/*", echoSwagger.WrapHandler);swag init 需指定 -d 和 -g 参数;注释需紧贴 handler 函数;@Param 类型须用 OpenAPI 标准名;docs.SwaggerInfo 需手动初始化。

echo框架路由怎么配合swagger生成接口文档

echo.New() 之后必须注册 echoSwagger.WrapHandler 路由

不加这行,访问 /swagger/index.html 就是 404。Echo 不像 Gin 那样自动挂载静态资源,它完全依赖你显式声明路由来暴露 Swagger UI。

常见错误是把 echoSwagger.WrapHandler 放在 e.GET("/swagger/*", ...) 之外,或者路径写成 /swagger/(少一个 *),导致无法匹配子路径(如 /swagger/swagger.json)。

正确写法:

e.GET("/swagger/*", echoSwagger.WrapHandler)

注意:* 是通配符,必须保留;echoSwagger 来自 github.com/swaggo/echo-swagger,不是 gin-swagger,别引错包。

swag init 必须能扫描到所有 handler 函数

echo 的路由注册(如 e.GET("/user/:id", handlerFunc))只是函数调用,swag 不会执行代码,只靠注释位置和文件路径静态分析。如果 handlerFunc 定义在 internal/handler,但你在模块根目录只跑 swag init,它根本看不到那个文件。

  • 必须用 -d 显式指定 handler 所在目录:swag init -d internal/handler -d api/v1
  • 必须用 -g 指定入口文件(含 e.GET 调用的 main 包):swag init -g cmd/app/main.go
  • handler 函数上方的注释块不能有空行,且必须紧贴函数声明;写在函数体内、或被注释隔开,swag 直接跳过
  • 所有 handler 文件的 package 不能是 main(除非真在那里注册路由),否则可能被忽略

@Param 和 @Success 的类型必须严格匹配 Echo 参数解析方式

Echo 本身不约束参数类型,但 swag 生成文档时全靠你手写 @Param,它不会读 c.Param("id") 或 c.QueryParam("page") 推断类型。

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

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

下载

例如路径参数 /user/:id,后端用 c.Param("id") 取值,但文档里必须写:

// @Param id path string true "用户ID"

不能写 int 或 int64 —— swag 不认这些,只认 string/integer/boolean 等 OpenAPI 基础类型名。

body 参数同理:@Param user body model.User true "用户信息",其中 model.User 必须是导出结构体,字段带 json:"xxx" tag,否则 schema 里字段为空。

docs/docs.go 初始化必须在 e.Start() 之前完成

swag init 生成的 docs/docs.go 是个内嵌静态资源文件,它内部有个 SwaggerInfo 全局变量。如果你没在 main() 开头设置标题和版本:

docs.SwaggerInfo.Title = "User API"
docs.SwaggerInfo.Version = "1.0"

Swagger UI 页面标题就是默认的 "Swagger API",而且某些字段(如 @host)若未声明,会导致请求地址错误(比如发请求时拼成 http://localhost:8080//users 多了个斜杠)。

更隐蔽的问题:如果 docs/docs.go 是用旧版 swag 生成的,而项目用了 Go 1.21+ workspace,swag init 可能静默失败——必须切到具体 module 目录下重跑,否则 docs/docs.go 里的资源数据为空,页面加载卡在 spinner。

相关文章

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

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

下载

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

热门AI工具

更多
DeepSeek

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

火山引擎

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

PixPix
PixPix Hot

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

UP简历
UP简历 Hot

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

豆包大模型

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

咔片AIPPT

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

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

WorkBuddy

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

二狗PPT
二狗PPT Hot

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

相关专题

更多
Uvicorn 报错与问题解决教程
Uvicorn 报错与问题解决教程

本专题汇总了Uvicorn服务器常见问题与报错解决的教程合集,涵盖启动失败、端口占用、模块导入错误、事件循环冲突及热重载失效等典型故障的排查思路。同时整理了多进程与Worker配置、SSL/HTTPS证书报错、跨域与代理配置等实战解决方案,助你快速定位并解决Uvicorn运行中的各类问题。

0

2026.11.02

Uvicorn使用教程
Uvicorn使用教程

本专题汇总了Uvicorn使用教程与启动运行指南,涵盖其作为Python ASGI服务器的定位与特点,以及命令行启动(uvicorn main:app --reload)、参数配置(host/port/workers)、程序内嵌运行与Gunicorn结合部署等核心用法。同时整理了热重载调试、日志配置与生产环境部署优化等技巧,助你快速掌握Uvicorn的运行与配置。

0

2026.11.02

Uvicorn安装配置教程
Uvicorn安装配置教程

本专题汇总了Uvicorn的安装配置教程与部署指南,涵盖通过pip安装Uvicorn、启动FastAPI/Starlette应用、开发模式热重载(--reload)及多进程工作模式配置等核心操作。同时整理了结合Gunicorn的生产部署方案、HTTPS与反向代理配置及性能调优技巧,助你快速完成Uvicorn服务的安装与上线部署。

0

2026.11.02

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

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

120

2026.10.28

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

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

80

2026.10.28

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

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

280

2026.10.28

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

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

160

2026.10.22

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

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

140

2026.10.22

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

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

100

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