使用 NSwag 生成 C# 客户端错误地在同一个文件中创建了 2x 个同名的部分类

Question

I'm trying to generate an NSwag C# Client, from an OpenAPI json file.

When I do this, I do get a client file generated, but it doesn't compile. It has created 2x partial classes in the same.cs file.

Now, if I change one of these class names to anything else, the file can now compile:

No errors - compiles OK.

So my question is: why is this doing it?

Here's a picture of my Swagger UI (this was generated with Swashbuckle, not NSwag):

So this means I have 2x controllers in the project:

• HomeController
• DocumentsController

Is there some trick to fixing this?

I used the following command line, to generate the client:

dotnet-openapi --updateProject.\MyProject.csproj http://localhost:5100/swagger/v1/swagger.json

Dotnet-openapi is using NSwag CSharpClientGenerator "under the hood", as far as I believe.

I'm happy to use any other tool to generate a C# client.

Answer 1

I do not know swagger, but as I can see in your images, one file contains the backing fields, while the other contains the properties. This is how code generators work in C#.

Code generators cannot change existing code. They can only create new code files. Therefore, partial classes are used. Partial classes are classes that can be split among several files. But otherwise, they are exactly like other classes.

Now, given a set of fields, a code generator can automatically create properties for these fields (it can do many other things, but this is what happens in this case), but it can only do this by creating another file.

The pairs of files with the same partial class are okay.

See also: Introducing C# Source Generators