grantph
commented
4 years ago When fully qualified names are present in the Swagger, NSwag only uses the last segment for Types.
Example:
ServiceA.Model.MyModel ===> MyModel ServiceB.Model.MyModel ===> MyModel
And a conflict is created.
To generate fully qualified names with Swashbuckle and replicate this behavior, add a call to UseFullTypeNameInSchemaIds().
config.EnableSwagger(c =>
{
// Enable Fully Qualified Names in Swagger
c.UseFullTypeNameInSchemaIds();
});This behavior is caused by the DefaultTypeNameGenerator in the NJsonSchema project, and not the NSwag project.
We were able to workaround this limitation by making 2 changes to the NJsonSchema project.
Modify Generate(JsonSchema schema, string typeNameHint) to return fully qualified type
From
protected virtual string Generate(JsonSchema schema, string typeNameHint)
{
if (string.IsNullOrEmpty(typeNameHint) && schema.HasTypeNameTitle)
{
typeNameHint = schema.Title;
}
var lastSegment = typeNameHint?.Split('.').Last();
return ConversionUtilities.ConvertToUpperCamelCase(lastSegment ?? "Anonymous", true);
}To
protected virtual string Generate(JsonSchema schema, string typeNameHint)
{
if (string.IsNullOrEmpty(typeNameHint) && schema.HasTypeNameTitle)
{
typeNameHint = schema.Title;
}
return typeNameHint;
//var lastSegment = typeNameHint?.Split('.').Last();
//return ConversionUtilities.ConvertToUpperCamelCase(lastSegment ?? "Anonymous", true);
}This change returns fully qualified names, however, it doesn't handle complex types such as ValueTuple<>. There will also be an impact on the use of "Anonymous" which we haven't had time to explore.
Before change
public async System.Threading.Tasks.Task<MyModel> GetAsync(...After change
public async System.Threading.Tasks.Task<ServiceA.Model.MyModel> GetAsync(...I find it interesting that a lot of NSwag code generation is fully qualified (like System.Threading.Tasks.Task above), yet the swagger types are not. This seems inconsistent.
Modify Generate(JsonSchema schema, string typeNameHint, IEnumerable reservedTypeNames) to handle complex types
From
typeNameHint = (typeNameHint ?? "")
.Replace("[", " Of ")
.Replace("]", " ")
.Replace("<", " Of ")
.Replace(">", " ")
.Replace(",", " And ")
.Replace(" ", " ");To
typeNameHint = (typeNameHint ?? "")
.Replace("[", "<")
.Replace("]", ">")
//.Replace("<", " Of ")
//.Replace(">", " ")
//.Replace(",", " And ")
.Replace(" ", " ");Example Tuple
System.ValueTuple<ServiceA.Model.MyModel,ServiceB.Model.MyModel>
or short-hand
(ServiceA.Model.MyModel, ServiceB.Model.MyModel)Before change
public async System.Threading.Tasks.Task<ValueTupleOfMyModelAndMyModel> GetAsync(...After change
public async System.Threading.Tasks.Task<System.ValueTuple<ServiceA.Model.MyModel, ServiceB.Model.MyModel>> GetAsync(...I would image that switching from "Last Segment" to "Fully Qualified" is a major change that will require full regression testing of NSwag, NJsonSchema, and other related projects, SO - we haven't created any official submission to the NJsonSchema project yet.
Perhaps @RicoSuter can comment on this?
RicoSuter
jdimmerman
Climax85
shainegordon
tiagopsantos
bvkeersop
I am generating a single client and might have collisions on Type with too many using statements. Is there a way to generate using fully qualified type names?