Open API 3.0 规范是否支持变更日志?

2023-12-19

我正在使用 Open API 3.0 规范来记录我的 API。

我观察到 Open API 3.0 有一个version属性。我想知道是否有办法记录变更日志。或者只使用externalDocs属性 ?


变更日志不是规范的内置功能,但版本字段绝对有助于作为生成它们的基础。我有一个 GitHub 操作,当规范版本号发生更改时,它会在 GitHub 上执行“发布”(这对我们所做的每次更改都会执行),因此发布页面将成为我们的更改日志。数据也可以从发布中获取(可通过 GitHub API 获取)。

至于指向变更日志 - externalDocs 可能是一个好方法。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

Open API 3.0 规范是否支持变更日志? 的相关文章

随机推荐