Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Rename model in Swashbuckle 6 (Swagger) with ASP.NET Core Web API

I'm using Swashbuckle 6 (Swagger) with ASP.NET Core Web API. My models have DTO as a suffix, e.g.,

public class TestDTO {
    public int Code { get; set; }
    public string Message { get; set; }
}

How do I rename it to just "Test" in the generated documentation? I've tried adding a DataContract attribute with a name, but that didn't help.

[HttpGet]
public IActionResult Get() {
  //... create List<TestDTO>
  return Ok(list);
}
like image 753
ultravelocity Avatar asked Nov 16 '16 23:11

ultravelocity


2 Answers

Figured it out... similar to the answer here: Swashbuckle rename Data Type in Model

The only difference was the property is now called CustomSchemaIds instead of SchemaId:

options.CustomSchemaIds(schemaIdStrategy);

Instead of looking at the DataContract attribute, I just have it remove "DTO":

private static string schemaIdStrategy(Type currentClass) {
    string returnedValue = currentClass.Name;
    if (returnedValue.EndsWith("DTO"))
        returnedValue = returnedValue.Replace("DTO", string.Empty);
    return returnedValue;
}
like image 106
ultravelocity Avatar answered Nov 07 '22 03:11

ultravelocity


The answer from @ultravelocity didnt quite work for me. The error was like "'Response`1' is already used". I dont know what was the exact reason, but i guess it was something about inheritance / generics (since i returned a paged responses).

Based on the question and answer from @ultravelocity I developed a possible solution for .net 5 (maybe for asp.net core 2.c/3.d also) which tackles this problem.

Steps:

  1. Add customSchemaId-Strategy like @ultravelocity did
a.CustomSchemaIds(schemaIdStrategy);
  1. Add your custom strategy function
private static string schemaIdStrategy(Type currentClass)
{
    string customSuffix = "Response";
    var tmpDisplayName = currentClass.ShortDisplayName().Replace("<", "").Replace(">", "");
    var removedSuffix = tmpDisplayName.EndsWith(customSuffix) ? tmpDisplayName.Substring(0, tmpDisplayName.Length - customSuffix.Length) : tmpDisplayName;
    return removedSuffix;
}
like image 1
ancube Avatar answered Nov 07 '22 03:11

ancube