Content Delivery API & SwaggerGen

[TradeSmash]

It'd be great if we could extend models builder to help generate swagger schemas for our document types.
For those using TypeScript, having this capability would be great as it saves a lot of time doing our own mappings and possibly run into issues where the types are out of date with the CMS.

I've got a very, very basic implementation using Document Filters, which doesn't really cover complex properties such as block lists.

public static class ReflectionUtility { public static IEnumerable<Type> GetTypesInheritingFrom(Type baseType, params Assembly[] assemblies) { return assemblies.SelectMany(assembly => assembly.GetTypes()) .Where(type => baseType.IsAssignableFrom(type) && type is { IsAbstract: false, IsClass: true }); } }

`
public class CustomDocumentFilter : IDocumentFilter
{
private readonly IEnumerable _contentModelTypes;

public CustomDocumentFilter(IEnumerable<Type> contentModelTypes)
{
    _contentModelTypes = contentModelTypes;
}

public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
{
    foreach (var modelType in _contentModelTypes)
    {
        var typeName = modelType.Name;

        if (swaggerDoc.Components.Schemas.ContainsKey(typeName)) continue;

        var schema = new OpenApiSchema
        {
            Type = "object"
        };

        foreach (var property in modelType.GetProperties())
        {
            var propertyType = property.PropertyType.Name;
            var propertyDescription = property.GetCustomAttribute<DescriptionAttribute>()?.Description;

            schema.Properties.Add(property.Name, new OpenApiSchema
            {
                Type = propertyType,
                Description = propertyDescription
            });
        }

        swaggerDoc.Components.Schemas[typeName] = schema;
    }
}

}
`

`
services.AddSwaggerGen(options =>
{
var coreAssembly = Assembly.Load("SampleProject.Core");
var contentModelTypes = ReflectionUtility.GetTypesInheritingFrom(typeof(PublishedContentModel), coreAssembly).ToList();

        options.DocumentFilter<CustomDocumentFilter>(contentModelTypes);
    });

`

And here's the output: