如何从Go源代码生成OpenAPI v3规范?
亲爱的编程学习爱好者,如果你点开了这篇文章,说明你对《如何从Go源代码生成OpenAPI v3规范?》很感兴趣。本篇文章就来给大家详细解析一下,主要介绍一下,希望所有认真读完的童鞋们,都有实质性的提高。
有没有办法从go源代码生成openapi v3规范?假设我可以尝试一下 像下面这样的 api,我想从中生成 openapi 规范(yaml 文件)。类似于python的flask restx。我知道有一些工具可以根据规范生成 go 源代码,但是,我想以相反的方式进行操作。
package main
import "net/http"
func main() {
http.HandleFunc("/hello", func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("world\n"))
})
http.ListenAndServe(":5050", nil)
}
解决方案
您可以使用 github.com/swaggest/rest 构建自记录 http rest api。该库建立了一个约定,以可用于反映文档和模式并维护有关它的单一事实来源的方式声明处理程序。
我个人认为,与规范优先方法相比,代码优先方法具有优势。它不需要成为规范语言语法方面的专家,因此可以降低入门门槛。它可能有助于提出一个与实现细节很好平衡的规范。
使用代码优先方法,无需实现完整的服务来获取规范。您只需要定义结构和接口,可以推迟实际的逻辑实现。
请查看简单使用example。
package main
import (
"context"
"errors"
"fmt"
"log"
"net/http"
"time"
"github.com/go-chi/chi"
"github.com/go-chi/chi/middleware"
"github.com/swaggest/rest"
"github.com/swaggest/rest/chirouter"
"github.com/swaggest/rest/jsonschema"
"github.com/swaggest/rest/nethttp"
"github.com/swaggest/rest/openapi"
"github.com/swaggest/rest/request"
"github.com/swaggest/rest/response"
"github.com/swaggest/rest/response/gzip"
"github.com/swaggest/swgui/v3cdn"
"github.com/swaggest/usecase"
"github.com/swaggest/usecase/status"
)
func main() {
// init api documentation schema.
apischema := &openapi.collector{}
apischema.reflector().specens().info.title = "basic example"
apischema.reflector().specens().info.withdescription("this app showcases a trivial rest api.")
apischema.reflector().specens().info.version = "v1.2.3"
// setup request decoder and validator.
validatorfactory := jsonschema.newfactory(apischema, apischema)
decoderfactory := request.newdecoderfactory()
decoderfactory.applydefaults = true
decoderfactory.setdecoderfunc(rest.paraminpath, chirouter.pathtourlvalues)
// create router.
r := chirouter.newwrapper(chi.newrouter())
// setup middlewares.
r.use(
middleware.recoverer, // panic recovery.
nethttp.openapimiddleware(apischema), // documentation collector.
request.decodermiddleware(decoderfactory), // request decoder setup.
request.validatormiddleware(validatorfactory), // request validator setup.
response.encodermiddleware, // response encoder setup.
gzip.middleware, // response compression with support for direct gzip pass through.
)
// create use case interactor.
u := usecase.iointeractor{}
// describe use case interactor.
u.settitle("greeter")
u.setdescription("greeter greets you.")
// declare input port type.
type helloinput struct {
locale string `query:"locale" default:"en-us" pattern:"^[a-z]{2}-[a-z]{2}$" enum:"ru-ru,en-us"`
name string `path:"name" minlength:"3"` // field tags define parameter location and json schema constraints.
}
u.input = new(helloinput)
// declare output port type.
type hellooutput struct {
now time.time `header:"x-now" json:"-"`
message string `json:"message"`
}
u.output = new(hellooutput)
u.setexpectederrors(status.invalidargument)
messages := map[string]string{
"en-us": "hello, %s!",
"ru-ru": "Привет, %s!",
}
u.interactor = usecase.interact(func(ctx context.context, input, output interface{}) error {
var (
in = input.(*helloinput)
out = output.(*hellooutput)
)
msg, available := messages[in.locale]
if !available {
return status.wrap(errors.new("unknown locale"), status.invalidargument)
}
out.message = fmt.sprintf(msg, in.name)
out.now = time.now()
return nil
})
// add use case handler to router.
r.method(http.methodget, "/hello/{name}", nethttp.newhandler(u))
// swagger ui endpoint at /docs.
r.method(http.methodget, "/docs/openapi.json", apischema)
r.mount("/docs", v3cdn.newhandler(apischema.reflector().spec.info.title,
"/docs/openapi.json", "/docs"))
// start server.
log.println("http://localhost:8011/docs")
if err := http.listenandserve(":8011", r); err != nil {
log.fatal(err)
}
}您可以使用 Huma(完全公开:我是作者)从 go 代码生成 openapi 3.1 和 json schema,它适用于各种流行的路由器,因此可以根据需要集成到现有代码库中。 huma 利用 go 泛型为输入参数、主体、响应头等提供编译时检查。
这是一个简单的 hello world 示例,只有几行:
package main
import (
"context"
"fmt"
"net/http"
"github.com/danielgtaylor/huma/v2"
"github.com/danielgtaylor/huma/v2/adapters/humachi"
"github.com/go-chi/chi/v5"
)
// greetinginput represents the greeting operation request.
type greetinginput struct {
name string `path:"name" maxlength:"30" example:"world" doc:"name to greet"`
}
// greetingoutput represents the greeting operation response.
type greetingoutput struct {
body struct {
message string `json:"message" example:"hello, world!" doc:"greeting message"`
}
}
func main() {
// create a new router & api
router := chi.newmux()
api := humachi.new(router, huma.defaultconfig("my api", "1.0.0"))
// register get /greeting/{name}
huma.register(api, huma.operation{
operationid: "get-greeting",
summary: "get a greeting",
method: http.methodget,
path: "/greeting/{name}",
}, func(ctx context.context, input *greetinginput) (*greetingoutput, error) {
resp := &greetingoutput{}
resp.body.message = fmt.sprintf("hello, %s!", input.name)
return resp, nil
})
// start the server!
http.listenandserve("127.0.0.1:8888", router)
}
然后您可以轻松地从服务获取生成的 openapi:
curl http://localhost:8888/openapi.json
您还可以在 http://localhost:8888/docs 查看 openapi 生成的文档。
今天关于《如何从Go源代码生成OpenAPI v3规范?》的内容介绍就到此结束,如果有什么疑问或者建议,可以在golang学习网公众号下多多回复交流;文中若有不正之处,也希望回复留言以告知!
golang 函数与方法的区别是?
- 上一篇
- golang 函数与方法的区别是?
- 下一篇
- WIN10设置虚拟内存的操作内容
-
- Golang · Go问答 | 3小时前 |
- Go httptrace.Wait100Continue 怎样定位客户端等待 100 Continue
- 146浏览 收藏
-
- Golang · Go问答 | 4小时前 |
- Go http.CrossOriginProtection.AddTrustedOrigin 怎样放行受信任来源
- 347浏览 收藏
-
- Golang · Go问答 | 4小时前 | 网络编程 · HTTP · Go问答 · Go HTTP代理 httputil ReverseProxy ModifyResponse
- Go httputil.ReverseProxy.ModifyResponse 怎样改写上游响应
- 288浏览 收藏
-
- Golang · Go问答 | 4小时前 |
- Go os.Root.Close 后为什么不能继续打开文件
- 182浏览 收藏
-
- Golang · Go问答 | 4小时前 |
- Go http.Client 跟随重定向时如何保留认证头
- 290浏览 收藏
-
- Golang · Go问答 | 4小时前 | ip地址 · Go问答 · Go CIDR net/netip Prefix.Masked 网段规范化
- Go netip.Prefix.Masked 怎样规范化带主机位的 CIDR
- 452浏览 收藏
-
- Golang · Go问答 | 4小时前 |
- Go token.File.LineCount 统计源码行数的边界与位置映射
- 294浏览 收藏
-
- Golang · Go问答 | 4小时前 | Go问答 · Go pkix.Name x509 Certificate.Subject 证书主体
- Go x509.Certificate.Subject 怎样读取证书主体信息
- 298浏览 收藏
-
- Golang · Go问答 | 4小时前 | 标准库 · 工程实践 · HTTP客户端 · Go问答 · Go net/http keep-alive HTTP连接 Request.Close
- Go http.Request.Close 怎样让客户端主动关闭 HTTP 连接
- 135浏览 收藏
-
- Golang · Go问答 | 4小时前 | DNS Go timeout errors.As net.DNSError Temporary
- Go net.DNSError 怎样区分 DNS 超时与临时错误
- 140浏览 收藏
-
- Golang · Go问答 | 4小时前 |
- Go os/exec.Cmd.Err 怎样判断命令在启动前就失败
- 125浏览 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 485次学习
-
- PubMedQA
- 深入了解PubMedQA生物医学问答数据集,涵盖其核心功能、使用方法及在临床决策、药物研发等场景的应用,助力提升NLP模型性能。
- 1083次使用
-
- H2O EvalGPT
- H2O EvalGPT是H2O.ai推出的开源LLM评估平台,提供详细的大模型性能排行榜、行业特定基准测试及A/B测试功能,助您快速选择最适合项目的高性能大语言模型。
- 1084次使用
-
- LMArena
- LMArena是加州大学伯克利分校推出的AI模型匿名评测平台。通过盲测投票机制,用户可对比不同大模型回答并生成实时排行榜,助力开发者优化模型及用户选择最佳AI工具。
- 1246次使用
-
- HELM
- 深入了解斯坦福推出的HELM(Holistic Evaluation of Language Models)大模型评测体系。本文解析其核心功能、安装配置步骤及应用场景,涵盖准确性、公平性、鲁棒性等多维度指标,助力开发者全面优化语言模型性能。
- 1191次使用
-
- MMBench
- MMBench是由上海人工智能实验室等机构联合推出的多模态基准测试平台,提供细粒度能力评估、大规模数据集及VLMEvalKit工具。本文详细介绍其核心功能、安装使用方法及应用场景,助力开发者全面评估多模态模型性能。
- 1036次使用
-
- 用Nginx反向代理部署go写的网站。
- 2023-01-17 502浏览
-
- GoLand调式动态执行代码
- 2023-01-13 502浏览
-
- Go gosym.Sym.BaseName 怎样去掉符号的包名与接收者
- 2026-11-17 501浏览
-
- 正则命名捕获组取不到值怎么办
- 2026-11-15 501浏览
-
- Go pprof profile duration 参数如何理解
- 2026-11-14 501浏览

