Manually set operationId to allow multiple operations with the same verb in Swashbuckle

Question

I need to know if it's possible to set up custom operationid, or a naming convention, I mean I know that operation filter can be overwritten the way how operationId is generated

https://azure.microsoft.com/en-us/documentation/articles/app-service-api-dotnet-swashbuckle-customize/

using Swashbuckle.Swagger;
using System.Web.Http.Description;

namespace Something
{
    public class MultipleOperationsWithSameVerbFilter : IOperationFilter
    {
        public void Apply(
            Operation operation,
            SchemaRegistry schemaRegistry,
            ApiDescription apiDescription)
        {
            if (operation.parameters != null)
            {
                operation.operationId += "By";
                foreach (var parm in operation.parameters)
                {
                    operation.operationId += string.Format("{0}",parm.name);
                }
            }
        }
    }
}

in SwaggerConfig.cs

 c.OperationFilter<MultipleOperationsWithSameVerbFilter>();

Now this is helpful transforming swagger description, check bellow:

All good, now I endup with another problem, example similar with may cases: on same controller I have two endpoints

Post: /customer boddy: {email, location....}
Post: /customer/search boddy: {a filter, whatever}

The example is not quite correct (last post should be a get) but still le assume that webapi cannot be changed (new controller for separation) for this particular case I will try to figure out a way to generate operationId diffrent for each action somehow, but my question is this:

Is it possible to decorate somehow the controller actions similar with [JsonIgnore] or with [Route("customer/delete")], to be explicit about the operationId.

venerik · Accepted Answer · 2020-03-09 10:16:30Z

31

EDIT This answer relates to Swashbuckle 5.6 and .NET Framework. Please read mwilson's answer for Swashbuckle and .NET Core

You can use the SwaggerOperationAttribute provided by Swashbuckle for that.

[SwaggerOperation("get")]
public IEnumerable<Contact> Get()
{
    ....
}

[SwaggerOperation("getById")]
public IEnumerable<Contact> Get(string id)
{
    ...
}

You can use that attribute to add tags and schemes to your operation as well by the way. Have a look at the source code

edited Mar 9, 2020 at 10:16

answered Sep 11, 2016 at 10:47

venerik

5,9122 gold badges36 silver badges45 bronze badges

Sign up to request clarification or add additional context in comments.

5 Comments

Simon_Weaver Over a year ago

Shouldn't this be "Contact_get" and "Contact_getById"?

Olavi Vaino Over a year ago

For some reason [SwaggerOperation("operationId")] didn't work in our case. Using .Net Core 3.1 and swashbuckle 5.6.0. However [HttpGet(Name = "operationId")] works.

apincik Over a year ago

You have to set OperationId property, [SwaggerOperation(OperationId = "MyCustomName")] , NetCore 3.1, swash* 5.2.x

David Keaveny Over a year ago

@Simon_Weaver Visual Studio's Connected Services feature will choke on operation IDs if they contain underscores (see stackoverflow.com/questions/68166935/…)

clfaster Over a year ago

Don't forget to add enable Annotations: services.AddSwaggerGen(c =>{c.EnableAnnotations();});

mwilson · Accepted Answer · 2020-03-30 16:06:15Z

25

For swashbuckle 5.0, you can use the Name attribute. You can set it to any string but I'm a fan of using nameof like this: nameof(ActualMethodName).

[HttpGet("{id:int}", Name = nameof(GetProductById))]
public IActionResult GetProductById(int id) // operationId = "GetProductById"'

or

[HttpGet("{id:int}", Name = "GetProductById")]
public IActionResult GetProductById(int id) // operationId = "GetProductById"'

There are a few other options listed here

edited Mar 30, 2020 at 16:06

answered Oct 26, 2019 at 2:38

mwilson

13.1k10 gold badges65 silver badges103 bronze badges

2 Comments

Perrier Over a year ago

You can use [action] and [controller] variables here, too. eg: [HttpGet(Name = "[controller]_[action]")] produces Contact_Get on the HttpGet method of ContactController.

user13889515 Over a year ago

see question here, stackoverflow.com/questions/63144598/…

Collectives™ on Stack Overflow

Manually set operationId to allow multiple operations with the same verb in Swashbuckle

2 Answers 2

5 Comments

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

5 Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related