Swagger中类名重复时报错

在asp.net core webapi接口返回的dto中如果类型中有两个属性类名一样但是引用的命名空间不一样时，swagger解析Schema时会报错：System.InvalidOperationException: Can’t use schemaId “$Class1” for type “$ClassLibrary2.Class1”. The same schemaId is already used for type “$ClassLibrary1.Class1”。

---

问题

如题

解决

创建一个改名的SwashbuckleSchemaHelper

  public class SwashbuckleSchemaHelper
  {
      private readonly Dictionary<string, int> _schemaNameRepetition = new();

      // borrowed from https://github.com/domaindrivendev/Swashbuckle.AspNetCore/blob/95cb4d370e08e54eb04cf14e7e6388ca974a686e/src/Swashbuckle.AspNetCore.SwaggerGen/SchemaGenerator/SchemaGeneratorOptions.cs#L44
      private string DefaultSchemaIdSelector(Type modelType)
      {
          if (!modelType.IsConstructedGenericType) return modelType.Name.Replace("[]", "Array");

          var prefix = modelType.GetGenericArguments()
              .Select(genericArg => DefaultSchemaIdSelector(genericArg))
              .Aggregate((previous, current) => previous + current);

          return prefix + modelType.Name.Split('`').First();
      }

      public string GetSchemaId(Type modelType)
      {
          string id = DefaultSchemaIdSelector(modelType);

          if (!_schemaNameRepetition.ContainsKey(id))
              _schemaNameRepetition.Add(id, 0);

          int count = _schemaNameRepetition[id] + 1;
          _schemaNameRepetition[id] = count;

          return $"{id}{(count > 1 ? count.ToString() : "")}";
      }
  }

使用方法：

services.AddSwaggerGen(options =>
{
    var schemaHelper = new SwashbuckleSchemaHelper();
    options.CustomSchemaIds(type => schemaHelper.GetSchemaId(type));
});

原因

swagger以类名作为schema的唯一标识，当类名一样时就会报错。

---

参考资料

• SchemaId already used for different type

本文会经常更新，请阅读原文： https://dashenxian.github.io/post/Swagger%E4%B8%AD%E7%B1%BB%E5%90%8D%E9%87%8D%E5%A4%8D%E6%97%B6%E6%8A%A5%E9%94%99 ，以避免陈旧错误知识的误导，同时有更好的阅读体验。

本作品采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。欢迎转载、使用、重新发布，但务必保留文章署名 小神仙 （包含链接： https://dashenxian.github.io ），不得用于商业目的，基于本文修改后的作品务必以相同的许可发布。如有任何疑问，请 与我联系 (125880321@qq.com) 。