openapi - 如何使用 OpenApi 模式中的 OperationId？

Question

在 OpenApi 模式中，它包含 option 元素OperationId。

这是如何使用的，为什么它是可选的？好吧，至少对于 .NET Core 库“ Swashbuckle” ，他们说它是可选的。

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

标签： openapiswashbuckle

Answer 1

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