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

Kratos框架OpenAPI文档生成与查看方法

阿芳吖_3986

阿芳吖_3986

发布时间:2026-10-10 11:10:30

|

634人浏览过

|

来源于php中文网

原创

Kratos项目中可通过make api生成openapi.yaml并嵌入HTTP服务,访问http://localhost:8000/swagger/index.html即可使用交互式Swagger UI,无需手动编写YAML或部署独立服务。

kratos框架openapi文档生成与查看方法 - php中文网

在Kratos项目中快速生成并访问可交互的OpenAPI文档,避免手动编写YAML、反复重启服务或部署独立Swagger UI服务。

确认项目已启用OpenAPI生成能力

打开项目根目录下的 Makefile,查找是否包含 openapi_out 字样。若无,则需在 make api 对应的 protoc 命令中补全该参数;常见缺失会导致生成的 api/openapi.yaml 为空或根本不存在。

执行 make api 后检查 api/openapi.yaml 文件大小——若小于1KB,说明未正确启用 OpenAPI 插件,【必须重装 protoc-gen-openapiv2】,否则后续所有步骤均无效。

这一步操作起来很简单,直接把文件拖进去就行。

生成符合规范的OpenAPI YAML文档

方法一:使用 make api 自动生成(推荐)

确保 proto 文件中已添加 OpenAPI 注释支持,例如在 rpc 方法前加入:

option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { description: "获取用户信息"; };

运行 make api → 自动生成 api/openapi.yaml → 该文件即为 Swagger UI 可加载的标准 OpenAPI v3 文档。

方法二:手动触发 protoc 命令(调试用)

进入 api/ 目录,执行完整命令:

protoc --proto_path=. --proto_path=../third_party --openapi_out=fq_schema_naming=true,default_response=false:. helloworld/v1/greeter.proto

注意:路径错误或缺少 --proto_path=../third_party 将导致枚举、错误码等定义无法解析,生成的 YAML 中会缺失 status code 或 schema 引用。

Kratos框架 2.8.2
Kratos框架 2.8.2

Kratos框架 2.8.2 源码包下载,针对 Watch Resolver goroutine 测试及指标、日志默认值问题进行修正。

下载

将OpenAPI文档嵌入HTTP服务并访问

第一步:确认 configs/config.yaml 中已启用 Swagger UI 静态资源路由

检查是否存在如下配置段(无则手动添加):

http:
  addr: 0.0.0.0:8000
  middleware:
    - recovery
    - logging
  swagger:
    enable: true
    doc_url: /swagger/doc.json

第二步:修改 HTTP server 初始化逻辑

打开 cmd/[project]/main.go,在 http.NewServer 创建后,插入以下代码块:

srv := http.NewServer(http.WithMiddleware(middleware...))
// 嵌入 OpenAPI 文档
srv.Handle("/swagger/doc.json", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
  w.Header().Set("Content-Type", "application/json")
  b, _ := ioutil.ReadFile("api/openapi.yaml")
  yaml2json := yaml.YAMLToJSON(b)
  w.Write(yaml2json)
}))
// 挂载 Swagger UI
srv.HandlePrefix("/swagger/", http.StripPrefix("/swagger/", swaggerFiles.Handler))

第三步:引入必要依赖

在 main.go 的 import 中添加:

_ "github.com/swaggo/http-swagger"
"gopkg.in/yaml.v3"
"io/ioutil"

第四步:启动服务并访问

执行 kratos run → 等待控制台输出 [HTTP] server listening on: [::]:8000 → 浏览器打开 http://localhost:8000/swagger/index.html。

热门AI工具

更多
Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

UP简历
UP简历 Hot

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

WorkBuddy

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

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

PixPix
PixPix Hot

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

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

DeepSeek

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

豆包大模型

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

相关专题

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

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

206

2026.02.24

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

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

113

2026.02.24

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

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

637

2026.02.24

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

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

218

2026.02.24

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

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

457

2026.02.24

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

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

208

2026.02.24

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

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

564

2026.02.26

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

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

225

2026.02.26

Kratos框架HTTP与gRPC服务开发教程
Kratos框架HTTP与gRPC服务开发教程

本专题围绕Kratos框架双协议服务开发,涵盖HTTP路由与处理器编写、参数获取、gRPC服务实现与客户端调用、metadata上下文传递、encoding编解码注册、统一响应封装、超时控制与流式响应实现方法。

0

2026.10.10

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kratos框架快速入门
Kratos框架快速入门

共0课时 | 0人学习

Kratos框架v3文档
Kratos框架v3文档

共0课时 | 0人学习

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

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