Asp.Net core Swashbuckle set operationId

前端 未结 3 2043
梦谈多话
梦谈多话 2021-01-02 15:59

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

3条回答
  •  甜味超标
    2021-01-02 16:48

    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> 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

提交回复
热议问题