增加一组有限的选项；API重大变化？

以一个HTTP API端点为例，它发出以下响应模型：

{
    "type": "Dog",
    "name": "Jessi",
    ...
}

该type领域已经在文档中被描述为一个Dog，Cat或Fish。

例如Rat，是否将添加新选项视为API的重大更改？

将选项添加到有限列表（开发人员可以打开该列表）是否被视为对API的扩展或修改？

如果文档将该字段描述为“狗”，“猫”或“鱼”之一，则可以，添加其他类型会以向后不兼容的方式更改接口。完全可以想象，您的API使用者编写了特定的代码来处理狗和猫，而不是处理鱼。给定未知类型，该消费者将不知道如何处理您的响应。但这很大程度上取决于这些占位符类型“猫”和“鱼”在您实际的问题域中所代表的含义……

如果经常更改可能的类型列表，或者如果列表不是有限的，那么对此进行记录是明智的。根据您的用例，将所有可能类型的列表作为API的终结点公开可能会比较好-这样一来，您就可以添加或删除类型而不必更新API版本。但是，类型越动态，API使用者就越难以执行特定于类型的操作。扩展性还是易用性更重要，取决于您的用例和问题领域。

仅当可以从现有操作中返回“ Rat”时，它才会中断。

如果现有操作无法返回“ Rat”，则添加此新选项将无效。