CODEWITHSUNDEEP
asp.net-coreswashbuckle
Sébastien Krejci
Sébastien Krejci

Reputation: 471

Swashbuckle.AspNetCore SwaggerOperation attribute not found

I am trying to use Autorest and Swagger documentation created by the help of Swashbuckle.AspNetCore (3.0.0) in order to generate a REST API client.

The swagger documentation generated seems to be correct except that the operation name are not really nice.

"/api/Addresses/{id}": {
      "get": {
        "tags": [ "Address" ],
        "operationId": "ApiAddressesByIdGet",
        "consumes": [],
        "produces": [],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "type": "string",
            "format": "uuid"
          }
        ],
        "responses": { "200": { "description": "Success" } }
      },

I saw in many articles and also on the official documentation of SwashBuckle.AspNetCore that I can use an attribute to decorate my controller method like this:

[HttpGet]
[Produces("application/json")]
[ProducesResponseType((int)HttpStatusCode.NotFound)]
[ProducesResponseType(typeof(List<AddressDto>), (int)HttpStatusCode.OK)]
[SwaggerOperation("GetAllAdresses")]
public async Task<IActionResult> GetAllAsync()
{
   ....
}

Unfortunately, I got an error:

SwaggerOperationAttribute could not be found

I verified the NuGet packages installed and they are:

How can I solve the problem?

Upvotes: 29

Views: 35981

Answers (2)

CoOl
CoOl

Reputation: 2797

Another option is to set Name property for your HttpGet filter like this:

[HttpGet(Name = "GetAllAdresses")]
[Produces("application/json")]
[ProducesResponseType((int)HttpStatusCode.NotFound)]
[ProducesResponseType(typeof(List<AddressDto>), (int)HttpStatusCode.OK)]
[SwaggerOperation("GetAllAdresses")]
public async Task<IActionResult> GetAllAsync()
{
   ....
}

Upvotes: 4

ScottG
ScottG

Reputation: 11121

I ran across this today. I needed to add the following nuget package that was just added for V3.0.0:

Swashbuckle.AspNetCore.Annotations

Breaking changes are described here

Please also note that you need to add the following to Startup.cs or your Swagger extension: 

AddSwaggerGen(c => { ... c.EnableAnnotations(); })

Upvotes: 72

Related Questions