Как OperationId используется из схемы OpenApi?

Question

В схеме OpenApi он включает элемент option OperationId.

Как это используется и почему это необязательно? Ну, по крайней мере с. NET Базовой библиотекой "Swashbuckle" говорят, что это необязательно .

Я думаю, это связано с тем, как используется SDK. Например: я могу сделать Typescript SDK из любой действующей схемы OpenApi ... так что я предполагаю, что это каким-то образом связано с тем, как этот Typescript SDK генерируется, а затем используется / используется?

Answer 1

Да, одно из основных применений для operationId является основой для имени метода в сгенерированном SDK. Но это не единственное использование. Он также может быть использован, например, как якорь в сгенерированной документации. Его можно использовать везде, где необходим уникальный идентификатор операции.