.NET 8 - Newtonsoft.Json.JsonSerializationException: Error setting value to 'SelectedSwaggerGeneratorRaw' on 'NSwag.Commands.NSwagDocument'.

[jepperaskdk]

This bug seem similar to this, however I'm seeing this after upgrading from .NET 6 to .NET 8: #1576

Reproduce on a fresh API with no changes except nswag.json and adding nswag packages of 14.0.0-preview012. See this repository for a reproduce: https://github.com/jepperaskdk/nswagdotnet8

> dotnet "C:\Users\USER\.nuget\packages\nswag.msbuild\14.0.0-preview012\buildTransitive\../tools/Net80/dotnet-nswag.dll" run nswag.json
NSwag command line tool for .NET Core Net80, toolchain v14.0.0.0 (NJsonSchema v11.0.0.0 (Newtonsoft.Json v13.0.0.0))
Visit http://NSwag.org for more information.
NSwag bin directory: C:\Users\Jeppe\.nuget\packages\nswag.msbuild\14.0.0-preview012\tools\Net80

Executing file 'nswag.json' with variables ''...
Newtonsoft.Json.JsonSerializationException: Error setting value to 'SelectedSwaggerGeneratorRaw' on 'NSwag.Commands.NSwagDocument'.
 ---> System.NullReferenceException: Object reference not set to an instance of an object.
   at NSwag.Commands.NSwagDocumentBase.set_SelectedSwaggerGeneratorRaw(JObject value) in /_/src/NSwag.Commands/NSwagDocumentBase.cs:line 88
   at Newtonsoft.Json.Serialization.ExpressionValueProvider.SetValue(Object target, Object value)
   --- End of inner exception stack trace ---

[jepperaskdk]

After cloning/running nswag locally, it fails on the same line:

var collectionProperty = SwaggerGenerators.GetType().GetRuntimeProperty(key[0].ToString().ToUpperInvariant() + key.Substring(1));

Where the key is "WebApiToOpenApiCommand"

SwaggerGenerators.Items has the following items:

{NSwag.Commands.IOutputCommand[3]}
    [0]: {NSwag.Commands.Generation.FromDocumentCommand}
    [1]: {NSwag.Commands.CodeGeneration.JsonSchemaToOpenApiCommand}
    [2]: {NSwag.Commands.Generation.AspNetCore.AspNetCoreToOpenApiCommand}

Any idea why it is missing WebApiToOpenApiCommand?
EDIT: I see now it is announced that WebApiToOpenApiCommand is deprecated and removed: #4524

[Ben555555]

@jepperaskdk I have the same issue. Do you know what the alternative is for "webApiToOpenApi" in nswag.json?

It says: "Removed WebApiToOpenApiCommand: Use the WebApiOpenApiDocumentGenerator to build your own CLI referencing controllers project to generate OpenAPI without starting the app" which links to https://github.com/RicoSuter/NSwag/wiki/WebApiOpenApiDocumentGenerator and there it says it's deprecated and links to https://github.com/RicoSuter/NSwag/wiki/AspNetCoreOpenApiDocumentGenerator where I cannot find any information how to change it. If I remove the documentGenerator from the nswag.json, it will build, but it will generate some random services with the code generator "openApiToTypeScriptClient".

When I use "aspNetCoreToOpenApi" for the document configuration it will start so many .NET processes that I will have to restart my computer.

I'm confused.

Edit: For now it seems to work for me like this, by setting noBuild = true:

{
  "runtime": "Net80",
  "defaultVariables": "Configuration=Debug",
  "documentGenerator": {
    "aspNetCoreToOpenApi": {
      "project": "MySolution.Api.csproj",
      "documentName": "v1",
      "msBuildProjectExtensionsPath": null,
      "configuration": null,
      "runtime": null,
      "targetFramework": null,
      "noBuild": true,
      "msBuildOutputPath": null,
      "verbose": true,
      "workingDirectory": null,
      "aspNetCoreEnvironment": null,
      "output": null,
      "newLineBehavior": "Auto"
    }
  },
  "codeGenerators": {
    "openApiToTypeScriptClient": {

But in my case I actually wouldn't need to run Program.cs which it seems to do. I only want to generate the client scripts...

[jepperaskdk]

@Ben555555 I have done the same, and I also experience the same issue with .NET processes being spawned, and as such I have had to disable generating the API clients on build (in csproj). EDIT: Setting "noBuild": true fixes it, as it still generates clients.

It might be a different issue however. For this issue, I suggest to throw a helpful error that "WebApiToOpenApiCommand" is not supported, rather than an obscure uncaught exception.

[MehdiElMellali]

I'm encountering a similar issue when migrating from .NET 6 to .NET 8 with NSwag. The error regarding 'WebApiToOpenApiCommand' removal and its alternatives resonates with what I'm experiencing. Have you found any further insights or workarounds since your last comment? I've tried adjusting configurations as suggested but still facing challenges. Any advice or updates on this matter would be greatly appreciated! Thanks in advance."

[Havunen]

14.1.0 NSwag fails to following exception:

1>  CHANGED -> --\bin\CHANGED.dll
1>  NSwag command line tool for .NET 4.6.2+ WinX64, toolchain v14.1.0.0 (NJsonSchema v11.0.2.0 (Newtonsoft.Json v13.0.0.0))
1>  Visit http://NSwag.org for more information.
1>  NSwag bin directory: --\packages\NSwag.MSBuild.14.1.0\tools\Win
1>  
1>  Executing file 'CHANGED.nswag' with variables ''...
1>  Newtonsoft.Json.JsonSerializationException: Error setting value to 'SelectedSwaggerGeneratorRaw' on 'NSwag.Commands.NSwagDocument'. ---> System.NullReferenceException: Object reference not set to an instance of an object.
1>     at NSwag.Commands.NSwagDocumentBase.set_SelectedSwaggerGeneratorRaw(JObject value)
1>     at Newtonsoft.Json.Serialization.DynamicValueProvider.SetValue(Object target, Object value)
1>     --- End of inner exception stack trace ---
1>     at Newtonsoft.Json.Serialization.DynamicValueProvider.SetValue(Object target, Object value)
1>     at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.SetPropertyValue(JsonProperty property, JsonConverter propertyConverter, JsonContainerContract containerContract, JsonProperty containerProperty, JsonReader reader, Object target)
1>     at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.PopulateObject(Object newObject, JsonReader reader, JsonObjectContract contract, JsonProperty member, String id)
1>     at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.CreateObject(JsonReader reader, Type objectType, JsonContract contract, JsonProperty member, JsonContainerContract containerContract, JsonProperty containerMember, Object existingValue)
1>     at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.CreateValueInternal(JsonReader reader, Type objectType, JsonContract contract, JsonProperty member, JsonContainerContract containerContract, JsonProperty containerMember, Object existingValue)
1>     at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.Deserialize(JsonReader reader, Type objectType, Boolean checkAdditionalContent)
1>     at Newtonsoft.Json.JsonSerializer.DeserializeInternal(JsonReader reader, Type objectType)
1>     at Newtonsoft.Json.JsonConvert.DeserializeObject(String value, Type type, JsonSerializerSettings settings)
1>     at Newtonsoft.Json.JsonConvert.DeserializeObject[T](String value, JsonSerializerSettings settings)
1>     at NSwag.Commands.NSwagDocumentBase.FromJson[TDocument](String filePath, String data)
1>     at NSwag.Commands.NSwagDocumentBase.LoadDocument[TDocument](String filePath, String data)
1>     at NSwag.Commands.NSwagDocumentBase.<LoadAsync>d__35`1.MoveNext()
1>  --- End of stack trace from previous location where exception was thrown ---
1>     at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
1>     at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
1>     at NSwag.Commands.Document.ExecuteDocumentCommand.<ExecuteDocumentAsync>d__9.MoveNext()
1>  --- End of stack trace from previous location where exception was thrown ---
1>     at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
1>     at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
1>     at NSwag.Commands.Document.ExecuteDocumentCommand.<RunAsync>d__8.MoveNext()
1>  --- End of stack trace from previous location where exception was thrown ---
1>     at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
1>     at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
1>     at NConsole.CommandLineProcessor.<ProcessSingleAsync>d__12.MoveNext()
1>  --- End of stack trace from previous location where exception was thrown ---
1>     at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
1>     at NConsole.CommandLineProcessor.<ProcessAsync>d__11.MoveNext()
1>  --- End of stack trace from previous location where exception was thrown ---
1>     at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
1>     at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
1>     at NSwag.Commands.NSwagCommandProcessor.<ProcessAsync>d__3.MoveNext()
1>CHANGED.csproj(549,5): error MSB3073: The command ""--\packages\NSwag.MSBuild.14.1.0\build\../tools/Win/NSwag.exe" run OTPServices.nswag" exited with code -1.

csproj:

  <Target Name="NSwag" AfterTargets="Build">
    <Exec Command="$(NSwagExe) run CHANGED.nswag" />
  </Target>

CHANGED.nswag

{
  "runtime": "WinX64",
  "documentGenerator": {
    "webApiToOpenApi": {
      "controllerNames": [],
      "isAspNetCore": false,
      "defaultUrlTemplate": "api/{controller}/{id?}",
      "addMissingPathParameters": false,
      "defaultPropertyNameHandling": "Default",
      "defaultReferenceTypeNullHandling": "Null",
      "defaultEnumHandling": "Integer",
      "flattenInheritanceHierarchy": false,
      "generateKnownTypes": true,
      "generateXmlObjects": false,
      "generateAbstractProperties": false,
      "ignoreObsoleteProperties": false,
      "allowReferencesWithProperties": false,
      "excludedTypeNames": [],
      "infoTitle": "xxx",
      "infoVersion": "1.0.0",
      "output": "xxxxx.json",
      "outputType": "OpenApi3",
      "assemblyPaths": [
        "bin/xxxx.dll"
      ],
      "referencePaths": []
    }
  }
}

Downgrading to 13.20 works as expected