web-dev-qa-db-ja.com

Swashbuckleを使用してSwagger APIドキュメント/ OpenAPI仕様にサブクラスを含めるにはどうすればよいですか？

Asp.Net Web API 5.2プロジェクトがc＃にあり、Swashbuckleでドキュメントを生成しています。

Animal抽象クラスからのAnimalプロパティと、それに由来するDogおよびCatクラスのような継承を含むモデルがあります。

スワッシュバックルは、Animalクラスのスキーマのみを表示するので、ISchemaFilterを試してみましたが（それらも示唆しています）、それを機能させることができず、適切な例も見つかりませんでした。

誰でも手伝ってくれる？

c#apiswaggersubclassingopenapi
24
Paolo Vigori

Swashbuckleはポリモーフィズムを正しく実装していないようですが、サブクラスに関するパラメーターとしての作成者の見解を理解しています（アクションがAnimalクラスを想定し、dogオブジェクトまたはcatオブジェクトを使用して呼び出すと異なる動作をする場合は、 2つの異なるアクションがあります...）が、戻り値の型としては、Animalを返すのが正しいと私は信じており、オブジェクトはDogまたはCat型である可能性があります。

したがって、私のAPIを説明し、正しいガイドラインに沿って適切なJSONスキーマを生成するために（私がディスクリミネーターを説明する方法に注意してください。独自のディスクリミネーターがある場合は、その部分を特に変更する必要があるかもしれません）、ドキュメントとスキーマフィルターを使用します次のように：

SwaggerDocsConfig configuration;
.....
configuration.DocumentFilter<PolymorphismDocumentFilter<YourBaseClass>>();
configuration.SchemaFilter<PolymorphismSchemaFilter<YourBaseClass>>();
.....

public class PolymorphismSchemaFilter<T> : ISchemaFilter
{
    private readonly Lazy<HashSet<Type>> derivedTypes = new Lazy<HashSet<Type>>(Init);

    private static HashSet<Type> Init()
    {
        var abstractType = typeof(T);
        var dTypes = abstractType.Assembly
                                 .GetTypes()
                                 .Where(x => abstractType != x && abstractType.IsAssignableFrom(x));

        var result = new HashSet<Type>();

        foreach (var item in dTypes)
            result.Add(item);

        return result;
    }

    public void Apply(Schema schema, SchemaRegistry schemaRegistry, Type type)
    {
        if (!derivedTypes.Value.Contains(type)) return;

        var clonedSchema = new Schema
                                {
                                    properties = schema.properties,
                                    type = schema.type,
                                    required = schema.required
                                };

        //schemaRegistry.Definitions[typeof(T).Name]; does not work correctly in SwashBuckle
        var parentSchema = new Schema { @ref = "#/definitions/" + typeof(T).Name };   

        schema.allOf = new List<Schema> { parentSchema, clonedSchema };

        //reset properties for they are included in allOf, should be null but code does not handle it
        schema.properties = new Dictionary<string, Schema>();
    }
}

public class PolymorphismDocumentFilter<T> : IDocumentFilter
{
    public void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, System.Web.Http.Description.IApiExplorer apiExplorer)
    {
        RegisterSubClasses(schemaRegistry, typeof(T));
    }

    private static void RegisterSubClasses(SchemaRegistry schemaRegistry, Type abstractType)
    {
        const string discriminatorName = "discriminator";

        var parentSchema = schemaRegistry.Definitions[SchemaIdProvider.GetSchemaId(abstractType)];

        //set up a discriminator property (it must be required)
        parentSchema.discriminator = discriminatorName;
        parentSchema.required = new List<string> { discriminatorName };

        if (!parentSchema.properties.ContainsKey(discriminatorName))
            parentSchema.properties.Add(discriminatorName, new Schema { type = "string" });

        //register all subclasses
        var derivedTypes = abstractType.Assembly
                                       .GetTypes()
                                       .Where(x => abstractType != x && abstractType.IsAssignableFrom(x));

        foreach (var item in derivedTypes)
            schemaRegistry.GetOrRegister(item);
    }
}

前のコードで実装されているものは、「多態性をサポートするモデル」セクションで指定されています here 。基本的には、次のようなものが生成されます。

{
  "definitions": {
    "Pet": {
      "type": "object",
      "discriminator": "petType",
      "properties": {
        "name": {
          "type": "string"
        },
        "petType": {
          "type": "string"
        }
      },
      "required": [
        "name",
        "petType"
      ]
    },
    "Cat": {
      "description": "A representation of a cat",
      "allOf": [
        {
          "$ref": "#/definitions/Pet"
        },
        {
          "type": "object",
          "properties": {
            "huntingSkill": {
              "type": "string",
              "description": "The measured skill for hunting",
              "default": "lazy",
              "enum": [
                "clueless",
                "lazy",
                "adventurous",
                "aggressive"
              ]
            }
          },
          "required": [
            "huntingSkill"
          ]
        }
      ]
    },
    "Dog": {
      "description": "A representation of a dog",
      "allOf": [
        {
          "$ref": "#/definitions/Pet"
        },
        {
          "type": "object",
          "properties": {
            "packSize": {
              "type": "integer",
              "format": "int32",
              "description": "the size of the pack the dog is from",
              "default": 0,
              "minimum": 0
            }
          },
          "required": [
            "packSize"
          ]
        }
      ]
    }
  }
}
28
Paolo Vigori

パウロの素晴らしい答えを引き継ぐために、Swagger 2.0を使用している場合は、次のようにクラスを変更する必要があります。

public class PolymorphismSchemaFilter<T> : ISchemaFilter
{
    private readonly Lazy<HashSet<Type>> derivedTypes = new Lazy<HashSet<Type>>(Init);

    private static HashSet<Type> Init()
    {
        var abstractType = typeof(T);
        var dTypes = abstractType.Assembly
                                 .GetTypes()
                                 .Where(x => abstractType != x && abstractType.IsAssignableFrom(x));

        var result = new HashSet<Type>();

        foreach (var item in dTypes)
            result.Add(item);

        return result;
    }

    public void Apply(Schema model, SchemaFilterContext context)
    {
        if (!derivedTypes.Value.Contains(context.SystemType)) return;

        var clonedSchema = new Schema
        {
            Properties = model.Properties,
            Type = model.Type,
            Required = model.Required
        };

        //schemaRegistry.Definitions[typeof(T).Name]; does not work correctly in SwashBuckle
        var parentSchema = new Schema { Ref = "#/definitions/" + typeof(T).Name };

        model.AllOf = new List<Schema> { parentSchema, clonedSchema };

        //reset properties for they are included in allOf, should be null but code does not handle it
        model.Properties = new Dictionary<string, Schema>();
    }
}

public class PolymorphismDocumentFilter<T> : IDocumentFilter
{
    private static void RegisterSubClasses(ISchemaRegistry schemaRegistry, Type abstractType)
    {
        const string discriminatorName = "discriminator";

        var parentSchema = schemaRegistry.Definitions[abstractType.Name];

        //set up a discriminator property (it must be required)
        parentSchema.Discriminator = discriminatorName;
        parentSchema.Required = new List<string> { discriminatorName };

        if (!parentSchema.Properties.ContainsKey(discriminatorName))
            parentSchema.Properties.Add(discriminatorName, new Schema { Type = "string" });

        //register all subclasses
        var derivedTypes = abstractType.Assembly
                                       .GetTypes()
                                       .Where(x => abstractType != x && abstractType.IsAssignableFrom(x));

        foreach (var item in derivedTypes)
            schemaRegistry.GetOrRegister(item);
    }

    public void Apply(SwaggerDocument swaggerDoc, DocumentFilterContext context)
    {
        RegisterSubClasses(context.SchemaRegistry, typeof(T));
    }
}
14
Craig.Nicol

クレイグの回答についてフォローアップしたいと思います。

NSwagを使用して、 Pauloの回答 で説明されている方法を使用してSwashbuckle（執筆時点では3.x）で生成されたSwagger APIドキュメントからTypeScript定義を生成し、さらに Craigの回答で拡張された場合 おそらく次の問題に直面するでしょう：

  1. 生成されたTypeScript定義は、生成されたクラスが基本クラスを拡張する場合でも、重複したプロパティを持ちます。次のC＃クラスを考えてみます。

    public abstract class BaseClass
{
    public string BaseProperty { get; set; }
}

public class ChildClass : BaseClass
{
    public string ChildProperty { get; set; }
}

    前述の回答を使用すると、IBaseClassおよびIChildClassインターフェイスのTypeScript定義は次のようになります。

    export interface IBaseClass {
    baseProperty : string | undefined;
}

export interface IChildClass extends IBaseClass {
    baseProperty : string | undefined;
    childProperty: string | undefined;
}

    ご覧のとおり、basePropertyは基本クラスと子クラスの両方で誤って定義されています。これを解決するには、PolymorphismSchemaFilter<T>クラスのApplyメソッドを変更して、所有するプロパティのみをスキーマに含める、つまり、継承されたプロパティを現在のタイプのスキーマから除外します。次に例を示します。

    public void Apply(Schema model, SchemaFilterContext context)
{
    ...

    // Prepare a dictionary of inherited properties
    var inheritedProperties = context.SystemType.GetProperties()
        .Where(x => x.DeclaringType != context.SystemType)
        .ToDictionary(x => x.Name, StringComparer.OrdinalIgnoreCase);

    var clonedSchema = new Schema
    {
        // Exclude inherited properties. If not excluded, 
        // they would have appeared twice in nswag-generated TypeScript definition
        Properties =
            model.Properties.Where(x => !inheritedProperties.ContainsKey(x.Key))
                .ToDictionary(x => x.Key, x => x.Value),
        Type = model.Type,
        Required = model.Required
    };

    ...
}

  2. 生成されたTypeScript定義は、既存の中間抽象クラスのプロパティを参照しません。次のC＃クラスを考えてみます。

    public abstract class SuperClass
{
    public string SuperProperty { get; set; }
}

public abstract class IntermediateClass : SuperClass
{
     public string IntermediateProperty { get; set; }
}

public class ChildClass : BaseClass
{
    public string ChildProperty { get; set; }
}

    この場合、生成されるTypeScript定義は次のようになります。

    export interface ISuperClass {
    superProperty: string | undefined;
}        

export interface IIntermediateClass extends ISuperClass {
    intermediateProperty : string | undefined;
}

export interface IChildClass extends ISuperClass {
    childProperty: string | undefined;
}

    生成されたIChildClassインターフェースがISuperClassを直接拡張してIIntermediateClassインターフェースを無視し、IChildClassのインスタンスをintermediatePropertyプロパティなしで効果的に残すことに注意してください。 。

    次のコードを使用して、この問題を解決できます。

    public void Apply(Schema model, SchemaFilterContext context)
{
    ...

    // Use the BaseType name for parentSchema instead of typeof(T), 
    // because we could have more classes in the hierarchy
    var parentSchema = new Schema
    {
        Ref = "#/definitions/" + (context.SystemType.BaseType?.Name ?? typeof(T).Name)
    };

    ...
}

    これにより、子クラスが中間クラスを正しく参照するようになります。

結論として、最終的なコードは次のようになります：

    public void Apply(Schema model, SchemaFilterContext context)
    {
        if (!derivedTypes.Value.Contains(context.SystemType))
        {
            return;
        }

        // Prepare a dictionary of inherited properties
        var inheritedProperties = context.SystemType.GetProperties()
            .Where(x => x.DeclaringType != context.SystemType)
            .ToDictionary(x => x.Name, StringComparer.OrdinalIgnoreCase);

        var clonedSchema = new Schema
        {
            // Exclude inherited properties. If not excluded, 
            // they would have appeared twice in nswag-generated TypeScript definition
            Properties =
                model.Properties.Where(x => !inheritedProperties.ContainsKey(x.Key))
                    .ToDictionary(x => x.Key, x => x.Value),
            Type = model.Type,
            Required = model.Required
        };

        // Use the BaseType name for parentSchema instead of typeof(T), 
        // because we could have more abstract classes in the hierarchy
        var parentSchema = new Schema
        {
            Ref = "#/definitions/" + (context.SystemType.BaseType?.Name ?? typeof(T).Name)
        };
        model.AllOf = new List<Schema> { parentSchema, clonedSchema };

        // reset properties for they are included in allOf, should be null but code does not handle it
        model.Properties = new Dictionary<string, Schema>();
    }
7
Dejan Janjušević

最近、.NET Core 3.1とSwashbuckle.AspNetCore 5.0にアップグレードしました。APIは多少変更されています。誰かがこのフィルターを必要とする場合、ここに同様の動作を得るために最小限の変更を加えたコードがあります：

public class PolymorphismDocumentFilter<T> : IDocumentFilter
{
    public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
    {
        RegisterSubClasses(context.SchemaRepository, context.SchemaGenerator, typeof(T));
    }

    private static void RegisterSubClasses(SchemaRepository schemaRegistry, ISchemaGenerator schemaGenerator, Type abstractType)
    {
        const string discriminatorName = "$type";
        OpenApiSchema parentSchema = null;

        if (schemaRegistry.TryGetIdFor(abstractType, out string parentSchemaId))
            parentSchema = schemaRegistry.Schemas[parentSchemaId];
        else
            parentSchema = schemaRegistry.GetOrAdd(abstractType, parentSchemaId, () => new OpenApiSchema());

        // set up a discriminator property (it must be required)
        parentSchema.Discriminator = new OpenApiDiscriminator() { PropertyName = discriminatorName };
        parentSchema.Required = new HashSet<string> { discriminatorName };

        if (parentSchema.Properties == null)
            parentSchema.Properties = new Dictionary<string, OpenApiSchema>();

        if (!parentSchema.Properties.ContainsKey(discriminatorName))
            parentSchema.Properties.Add(discriminatorName, new OpenApiSchema() { Type = "string", Default = new OpenApiString(abstractType.FullName) });

        // register all subclasses
        var derivedTypes = abstractType.GetTypeInfo().Assembly.GetTypes()
            .Where(x => abstractType != x && abstractType.IsAssignableFrom(x));

        foreach (var item in derivedTypes)
            schemaGenerator.GenerateSchema(item, schemaRegistry);
    }
}

public class PolymorphismSchemaFilter<T> : ISchemaFilter
{
    private readonly Lazy<HashSet<Type>> derivedTypes = new Lazy<HashSet<Type>>(Init);

    public void Apply(OpenApiSchema schema, SchemaFilterContext context)
    {
        if (!derivedTypes.Value.Contains(context.Type)) return;

        Type type = context.Type;
        var clonedSchema = new OpenApiSchema
        {
            Properties = schema.Properties,
            Type = schema.Type,
            Required = schema.Required
        };

        // schemaRegistry.Definitions[typeof(T).Name]; does not work correctly in Swashbuckle.AspNetCore
        var parentSchema = new OpenApiSchema
        {
            Reference = new OpenApiReference() { ExternalResource = "#/definitions/" + typeof(T).Name }
        };

        var assemblyName = Assembly.GetAssembly(type).GetName();
        schema.Discriminator = new OpenApiDiscriminator() { PropertyName = "$type" };
        // This is required if you use Microsoft's AutoRest client to generate the JavaScript/TypeScript models
        schema.Extensions.Add("x-ms-discriminator-value", new OpenApiObject() { ["name"] = new OpenApiString($"{type.FullName}, {assemblyName.Name}") });
        schema.AllOf = new List<OpenApiSchema> { parentSchema, clonedSchema };

        // reset properties for they are included in allOf, should be null but code does not handle it
        schema.Properties = new Dictionary<string, OpenApiSchema>();
    }

    private static HashSet<Type> Init()
    {
        var abstractType = typeof(T);
        var dTypes = abstractType.GetTypeInfo().Assembly
            .GetTypes()
            .Where(x => abstractType != x && abstractType.IsAssignableFrom(x));

        var result = new HashSet<Type>();
        foreach (var item in dTypes)
            result.Add(item);
        return result;
    }
}

結果を完全に検証しませんでしたが、同じ動作をするようです。

また、これらの名前空間をインポートする必要があることに注意してください。

using Microsoft.OpenApi.Models;
using Microsoft.OpenApi.Any;
using System.Reflection;
using Swashbuckle.AspNetCore.SwaggerGen;
2
ivke