注意事项

Swagger 文档更新

适用场景：基于 sql 创建的 web 服务
操作流程：

1. 修改代码中的 Swagger 注解后
2. 执行命令：make docs（重新生成文档）
3. 重启服务：make run（使变更生效）

提示

每次修改 Swagger 注解后必须执行上述步骤才能生效。

数据删除机制

基于 SQL 创建的服务：

• 启用嵌入 Model → 采用软删除（标记删除状态）
• 未启用嵌入 Model → 采用物理删除（直接从数据库移除）

Protobuf 生成配置

适用场景：基于 Protobuf 创建的服务
默认行为：

• 执行 make proto 生成的 xxx.pb.go 文件
• 自动移除结构体字段的 json tag 中的 omitempty 属性

如需保留 omitempty：

1. 打开 scripts/protoc.sh 文件

2. 注释掉以下命令：

   sponge del-omitempty --dir=$protoBasePath --suffix-name=pb.go > /dev/null

---

使用 sponge 过程中，如果您觉得还有其他需要注意的事项，欢迎在评论区告诉我们。