Open API 3.0规范是否支持更改日志？

问题描述

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

我注意到Open API 3.0具有version属性。我想知道它是否可以记录变更日志。还是只使用externalDocs属性？

解决方法

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

关于指向变更日志-externalDocs可能是实现此目的的好方法。