一个从Go代码生成OpenAPI 3.1规范的静态分析工具,零注解,自动检测Gin、Echo、Chi、Fiber、net/http等框架,支持调用图分析和浏览器配置UI。
- v0.5.10
- 发布于
- 7 天前
- 91
- 星标
- 45
- 下载
- 同步于
- 2 天前
最新版本
v0.5.102026年9月22日 07:11下载慢?可在上方随时切换镜像源
项目说明
项目概述
APISpec 分析 Go 源码并从实际代码中生成 OpenAPI 3.1 规范(YAML 或 JSON),无需注解,自动检测框架并跟踪调用图到真实处理器。
主要功能
- 框架自动检测:支持 Gin、Echo、Chi、Fiber、Gorilla Mux、net/http
- 从真实代码推断:从 AST 和调用图分析路由、参数、请求体和响应类型
- 认证感知:检测路由保护方式和认证方案
- 类型感知:解析别名、枚举、泛型、数组,映射 validator 标签到 OpenAPI 约束
- 可视化:可选的 HTML 调用图图和浏览器配置 UI
适用人群
- Go API 开发者
- 需要文档自动生成的团队
- 使用多种 Go Web 框架的项目
快速上手
- 安装:
go install github.com/ehabterra/apispec/cmd/apispec@latest - 生成:
apispec --dir ./your-project --output openapi.yaml - 使用
apispecui进行浏览器配置和预览
核心优势
- 零注解,从真实代码生成
- 支持多种 Go Web 框架
- 可扩展的 YAML 模式配置
- 可视化调用图和配置 UI
历史版本
排序