Search code examples
c#asp.net-coreswaggerasp.net-core-webapiswashbuckle

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);
}

Solution

  • 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;
    }