如何从OpenApi模式中使用OperationId？

Question

在OpenApi模式中，它包括选项元素OperationId。

这是如何使用的，为什么是可选的？好吧，至少使用.NET Core库“ Swashbuckle” they say it's optional。

我的猜测是，它与SDK的使用方式有关。例如：我可以从任何有效的OpenApi模式制作Typescript SDK ...所以我猜测它与该Typescript SDK的生成方式以及使用/使用方式有某种联系？

Answer 1

是的，operationId的主要用途之一是作为生成的SDK中方法名称的基础。但这不是唯一的用途。它也可以用作例如生成文档中的锚点。可以在需要该操作唯一标识符的任何地方使用。