接口文档和实现长期不一致,用注解自动生成并接进 CI 校验

文档和实现不一致,多是因为靠人手维护;改成从代码注解生成,实现即文档。

Java 侧用 springdoc 扫描注解产出 OpenAPI,路径和参数都由代码决定。

CI 里生成一份与仓库版本比对,有差异就让构建失败,文档就再也漂不掉。

# 生成接口描述并与仓库里的文档比对
curl -s http://localhost:8080/v3/api-docs > openapi.json
git diff --exit-code openapi.json || echo '接口文档与实现不一致,请更新'
THE END
喜欢就支持一下吧
点赞14 分享
评论 抢沙发

请登录后发表评论

    暂无评论内容