CODEWITHSUNDEEP
asp.net-coreswaggerswashbuckle
Александр Сысоев
Александр Сысоев

Reputation: 1207

Asp.Net core Swashbuckle set operationId

How can I set swagger operationId attribute in Asp.Net Core 2.1 project? According to this post I should use SwaggerOperationAttribute but I cannot find it in Swashbuckle.AspNetCore library. Also there is an IOperationFilter

public interface IOperationFilter
{
    void Apply(Operation operation, OperationFilterContext context);
}

and I can't find any implementations for swagger generation purposes.

Upvotes: 29

Views: 27984

Answers (7)

Bowen
Bowen

Reputation: 563

You can also generate the operation id based on the action name which is the method name, I found this handy when generating the API client.

services.AddSwaggerGen(c =>
{
    c.CustomOperationIds(e => $"{e.ActionDescriptor.RouteValues["action"]}");
    c.SwaggerDoc("v1", new Info { Title = "Test API", Version = "v1" });
});

Upvotes: 8

Yogesh Patil
Yogesh Patil

Reputation: 181

add this line - swagger.CustomOperationIds(e => $"{e.RelativePath}"); in services.AddSwaggerGen function call

Upvotes: 3

Александр Сысоев
Александр Сысоев

Reputation: 1207

Finally, I came to this solution:

public class SwaggerOperationNameFilter : IOperationFilter
{
    public void Apply(Operation operation, OperationFilterContext context)
    {
        operation.OperationId = context.MethodInfo.DeclaringType.GetCustomAttributes(true)
            .Union(context.MethodInfo.GetCustomAttributes(true))
            .OfType<SwaggerOperationAttribute>()
            .Select(a => a.OperationId)
            .FirstOrDefault();
    }
}

[AttributeUsage(AttributeTargets.Method)]
public sealed class SwaggerOperationAttribute : Attribute
{
    public SwaggerOperationAttribute(string operationId)
    {
        OperationId = operationId;
    }

    public string OperationId { get; }
}

// Startup.cs
services.AddSwaggerGen(c =>
{
    ...
    c.OperationFilter<SwaggerOperationNameFilter>();
};

[HttpGet("{id:int}")]
[SwaggerOperation("GetById")]
public async Task<IActionResult> Get(int id)
{
    ...
}

But it still seems to me that I've reinvented the wheel.

Upvotes: 4

Ian Mercer
Ian Mercer

Reputation: 39277

Adding a Name parameter to [HttpGet]/[HttpPost] fails with an exception in the most recent version, but putting a Name parameter on the Route attribute seems to work:

/// <summary>
/// Get all devices
/// </summary>
[Route("devices", Name = "GetAllDevices")]
[Authorize]
[HttpGet]
[Produces(typeof(Device[]))]
public async Task<IActionResult> GetAllDevices() { ...}

Upvotes: 9

Grig M
Grig M

Reputation: 41

You can enable annotation on swagger with the Swashbuckle.AspNetCore.Annotations NuGet package. (https://github.com/domaindrivendev/Swashbuckle.AspNetCore/blob/master/README.md#swashbuckleaspnetcoreannotations)

Once annotations have been enabled, you can enrich the generated Operation metadata by decorating actions with a SwaggerOperationAttribute.

[HttpPost]

[SwaggerOperation(
    Summary = "Creates a new product",
    Description = "Requires admin privileges",
    OperationId = "CreateProduct",
    Tags = new[] { "Purchase", "Products" }
)]
public IActionResult Create([FromBody]Product product)

Upvotes: 4

Akshay H
Akshay H

Reputation: 226

Its pretty simple

Add EnableAnnotations in ConfigureService Method

            {
                options.SwaggerDoc("v1", new OpenApiInfo
                {
                    Title = "Project HTTP API",
                    Version = "v1",
                    Description = "...."
                });
                options.EnableAnnotations();
            });

And use in controllers

[SwaggerOperation(OperationId = "GET_API")]

You can see in this in Swagger Json as

get": {
        "tags": [
          "API"
        ],
        "summary": "....",
        "operationId": "GET_API"
}

Upvotes: 3

CoOl
CoOl

Reputation: 2797

There are 2 other options without having to write any extra code or add extra dependency like Swashbuckle.AspNetCore.Annotations

Option 1: Convention based - SwaggerGen has an option to set CustomOperationIds. So you can simply set it to use ControllerName_HttpMethod like this:

services.AddSwaggerGen(c =>
{
    c.CustomOperationIds(e => $"{e.ActionDescriptor.RouteValues["controller"]}_{e.HttpMethod}");
    c.SwaggerDoc("v1", new Info { Title = "Test API", Version = "v1" });
});

This will add operationIds to all your methods, following ControllerName_HttpMethod convention.

Option 2: ActionFilter/Attribute based - you can configure each Action method (as you'd do with SwaggerOperation action filter by simple adding a Name property to your HTTP verb action filter like this:

[HttpPost(Name="Post_Person")]
[ProducesResponseType(200)]
[ProducesResponseType(400)]
[ProducesResponseType(500)]
public async Task<ActionResult<Response>> PostAsync([FromBody]Request request)
{
    Response result = await _context.PostAsync(request);
    return Ok(result);
}

This works exactly like [SwaggerOperation(OperationId = "Post_Person")] but without the need of EnableAnnotations

Upvotes: 59

Related Questions