GraphQL API 中已弃用的参数（规范 2021）

这里没有很好的解决方案，但我可以告诉你我的团队决定做什么：要么创建“旁边具有相同名称的字段”（+ V2），要么创建一个具有“更好的名称”的同级字段（如果你有更好的名称）。

版本和新名称之间的权衡：

• 如果您选择使用V2，它不是那么“干净”，但很容易看到 API 使用者应该做什么以及他们应该使用什么。有时，您甚至可以在弃用原始版本之前创建 V2，阅读架构的人可能会看到 V2 并开始朝着那个方向努力。此外，这些客户已经在查看picture，因此他们更有可能pictureV2在您告诉他们之前看到。
• 如果您选择了一个“更好的名称”，最终的架构将是“干净的”；它不包含曾经有过不同内容的历史信息。但是，如果您引入了一个新名称，则必须在弃用时明确说明，并且您可能需要更仔细地沟通。API 使用者需要阅读弃用通知才能知道下一步该做什么，因为发生的事情并不明显。

值得一提的是，“清洁”问题确实存在，而且不仅仅是美观问题。第一次添加V*内容时可能会感觉很糟糕，但我发现，随着规模的扩大*，从长远来看，这样做会更容易。

* 此处的“大规模”可能意味着几种不同的含义，包括

• 模式增长：当您拥有一个不断增长的大型代码库或模式时，这个问题会经常出现。选择一个简单的版本控制策略可以让团队不必每次都放慢速度来做出新的决定。只需升级版本并继续前进即可。
• 客户群增长：当您拥有庞大的 API 消费者群时，这样的版本控制策略很容易理解，因此您不必一遍又一遍地重新教授它。
• 团队成长：当您拥有一个大型团队时，新团队成员一眼就能轻松理解的版本控制策略也无需重新学习。新人可以轻松“复制粘贴”并知道下一步该做什么。
• 架构增长：如果您最终选择子图和联合、拼接或类似路线，那么在所有系统中采用简单一致的策略将为您的客户提供一致性和可读性，即使您有不同的团队在不同的系统上工作。

因此，如果队友向我具体展示了你的例子并询问下一步该怎么做，我会给出这些选项，他们应该为他们的产品和客户做正确的事情。

1. pictureV2：您了解您的域名和客户。如果picture是合适的词，请使用pictureV2。
2. pictureUrl：您返回的是 URL，它是一个标量。您返回的不是“图片”，它可能有尺寸、替代文本、标题等。此外，如果您pictureUrl今天使用名称（当您只返回 URL 时），将来，如果您确实想引入这些其他属性，您可以使用picture（非标量名称）。我不建议对“可能发生”的事情进行过度设计，但如果您根据这一原则命名，您将来就可以添加功能，而不必为今天的可能而过度设计。
3. image：该术语传达与“图片”相同的相对含义，但在 API 设计中更为常见。
4. imageUrl：根据前面两点，我通常会推荐这个。