C# Api Client generation: how to ignore a controller from external source?

[ImreMedgyesi]

Hi,

I am using NSwag to generate C# Api client (.net 7.0). Is there a way to exclude a controller from the generated client only? The controller itself is defined in an external library and the swagger.json file should contain all the controllers.

[ogulcanturan]

Hey @ImreMedgyesi , you can hide external libraries controllers using Conventions - whether only one controller or whole assembly

ControllerHideFromExploringConvention copy this class,

Extensions

public static void AddControllerHideFromExploringConvention<TController>(this IList<IApplicationModelConvention> conventions, bool inherit = true)
{
    AddControllerHideFromExploringConvention(conventions, typeof(TController), inherit);
}

public static void AddControllerHideFromExploringConvention(this IList<IApplicationModelConvention> conventions, Type controllerType, bool inherit = true)
{
    if (conventions == null)
    {
        throw new ArgumentNullException(nameof(conventions));
    }

    if (controllerType.GetCustomAttribute(typeof(ControllerAttribute)) == null)
    {
        throw new NotSupportedException(GetInvalidControllerType(controllerType.Name));
    }

    conventions.Add(new ControllerHideFromExploringConvention(controllerType, inherit));
}
        
public static void AddControllerHideFromExploringConvention(this IList<IApplicationModelConvention> conventions, Assembly assembly, bool inherit = true)
{
    if (conventions == null)
    {
        throw new ArgumentNullException(nameof(conventions));
    }

    conventions.Add(new ControllerHideFromExploringConvention(assembly, inherit));
}

Registration

public virtual void ConfigureServices(IServiceCollection services)
{
    ...
    services.AddControllers().AddMvcOptions(opts =>
    {
        opts.Conventions.AddControllerHideFromExploringConvention<LauncherController>(); // Hide single controller
        opts.Conventions.AddControllerHideFromExploringConvention(typeof(LauncherController).Assembly); // Hide all assembly
    });
    ...
}