AutoRest–OperationId is required for all operations

Baca Juga

I was trying to use AutoRest to generate a client SDK for one of my API’s. This turned out not to be the success I was hoping for. I downloaded the swagger.json file for my API and executed AutoRest through the following command:

autorest --csharp --input-file=swagger.json

This command failed with the following exception message:

FATAL: OperationId is required for all operations.

Here was the API controller I was using:

And here is an extract of the generated swagger.json:

As you can see, there is indeed no OperationId specified in the swagger.json. The swagger documentation has the following to tell about the OperationId:

operationId is an optional unique string used to identify an operation. If provided, these IDs must be unique among all operations described in your API.

Some common use cases for operationId are:

• Some code generators use this value to name the corresponding methods in code.



• Links can refer to the linked operations by operationId.

AutoRest uses the OperationId to identify each method. Unfortunately as the OperationId is optional, it is not generated by Swashbuckle automatically.

To change this, you can add an extra line in your Swashbuckle configuration;

This will use the ActionName as the OperationId. Of course you can also use a different naming strategy.