常见问题

日志链路追踪

• 如果你没有使用 gen api 自动生成代码，那么你需要在路由中手动加入 r.Use(middleware.Begin()) 中间件

• 如果使用的是代码生成，那就可以直接使用了

在业务逻辑中就可以通过 gooze.Log.WithCtx(ctx)，实现链路追踪

TIP

这个方案需要确保每个需要记录日志的方法的第一个参数都是 ctx context.Context

使用 Swagger 文档

前提是你使用的 gen api 自动生成代码，才会自动生成 Swagger 文档

目前每个 handler 中的方法都提供了 Swagger 的注释，而且生成了对应的 Swagger yaml 文件

你有两种方式使用：

1. 使用 gin-swagger 配合 Swagger UI 实现在线预览

2. 把 Swagger yaml 文件导入到 apifox、postman 等工具中

为什么 gooze 没有采用方案 1 实现在线预览？

对于每个项目来说，接口文档都是不可外传的，而且我使用的是自建 yapi 文档平台，所以没有采用方案 1

而且 gin-swagger 是一个非常优秀的库，基本的注释已经生成好了，如果你有需要，可以自行实现