由 Swagger 生成的 API 文档无法准确描述当前的 API 表面
作者: LinkinStars创建于 2026年7月20日更新于 2026年9月17日
标签documentation
背景
Apache Answer 使用 swaggo/swag 从 Go 控制器中的注解生成 REST API 文档。生成的文件(docs/swagger.json、docs/swagger.yaml 和 docs/docs.go)旨在为贡献者、集成者和第三方开发者提供权威的 API 参考。然而,源注解随着时间的推移已经偏离了实际实现,因此生成的文档不再能够满足这一角色。
内容来源: apache/answer