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);
}
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;
}
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:
a.CustomSchemaIds(schemaIdStrategy);
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;
}
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With