Content Delivery API & SwaggerGen

[RyanHelmn]

It'd be great for a way to generate Swagger Schema for document types & properties to expose them to the front end, especially with TypeScript projects.

Having the ability to generate API Clients & map the types straight from Swagger can save a lot of headaches for integrating with the Content Delivery API.

I've gone ahead and put together a very, very basic workaround for a project I'm working on, this doesn't cover more complex properties however such as MNTP, Block Lists etc.

public class CustomDocumentFilter : IDocumentFilter
{
    private readonly IEnumerable<Type> _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;
        }
    }
}

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 });
    }
}

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

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

And an example of the output

[vsilvar]

I agree this would be specially useful.

@RyanHelmn I've done an initial implementation in lauraneto/Umbraco.Headless.Blazor#1, that already supports complex types, and should generate fully complete models, so feel free to check it out.

[RyanHelmn]

Ah this is class! This saves me a lot of time with a project I'm working on