Provide API metadata

First, make sure you have Swashbuckle installed and configured in your project.

• Swashbuckle - ASP.NET Core
• Swashbuckle - ASP.NET Core - Newtonsoft (Optional: This package is necessary only for DotVVM 2.5+ projects that target ASP.NET Core 2.x, or projects using Newtonsoft.Json serializer with ASP.NET Core 3.x)

Then install the following NuGet package to the REST API project:

Install-Package DotVVM.Api.Swashbuckle.AspNetCore

# optional - install only if you are using Newtonsoft.Json
Install-Package Swashbuckle.AspNetCore.Newtonsoft

To enable DotVVM integration, call the EnableDotvvmIntegration extension method in the Swashbuckle configuration in Startup.cs file.

services.Configure<DotvvmApiOptions>(opt => 
{
    // TODO: configure DotVVM Swashbuckle options
});

services.AddSwaggerGen(options => {
    ...
    options.EnableDotvvmIntegration();
});

Optional: In case of DotVVM 2.5 or newer with ASP.NET Core 2.x, or ASP.NET Core 3.x with Newtonsoft.Json serializer, you also need to call AddSwaggerGenNewtonsoftSupport.

services.AddSwaggerGenNewtonsoftSupport();

First, make sure you have Swashbuckle installed and configured in your project.

• Swashbuckle - classic ASP.NET

Then, install the following NuGet package to the REST API project:

Install-Package DotVVM.Api.Swashbuckle.Owin

To enable DotVVM integration, call the EnableDotvvmIntegration extension method in the Swashbuckle configuration in SwaggerConfig.cs file.

config.EnableSwagger(c =>
    {
        ...
        c.EnableDotvvmIntegration(opt => 
        {
            // TODO: configure DotVVM Swashbuckle options    
        });
    })
    .EnableSwaggerUi(c => { ... });

services.Configure<DotvvmApiOptions>(opt => 
{
    // add a single type
    opt.AddKnownType(typeof(Order));

    // add all types from the assembly
    opt.AddKnownAssembly(typeof(Order).Assembly);

    // add all types from the namespace
    opt.AddKnownNamespace(typeof(Order).Namespace);
});

c.EnableDotvvmIntegration(opt => 
{
    // add a single type
    opt.AddKnownType(typeof(Order));

    // add all types from the assembly
    opt.AddKnownAssembly(typeof(Order).Assembly);

    // add all types from the namespace
    opt.AddKnownNamespace(typeof(Order).Namespace);
});