Question: could I include the controller xml documentation?

[WeihanLi]

Hi there, could we include the controller xml documentation?
I had configured the project file to generate the xml documentation file, while it does not work for the controller documentation

[ovska]

Did you remember to include the documentation in the swagger doc? I don't think this is a NSwag problem.

For example, using Swashbuckle:

services.AddSwaggerGen(
    options =>
    {
        var filePath = Path.Combine(
            AppContext.BaseDirectory,
            $"{typeof(Startup).Assembly.GetName().Name}.xml");
        options.IncludeXmlComments(filePath);
        // ...
    });

[WeihanLi]

Did you remember to include the documentation in the swagger doc

@ovska I do generate the xml documentation file, while find no API to include the xml documentation,
and besides, I can see the documentation for the action method

[StingyJack]

@WeihanLi - I get the controller documentation in the swagger doc

And they are also on the generated client.

Are you referring to something else? If so, can you give an example?

[WeihanLi]

Hi @StingyJack , that's documentation comment from the action method, I can get that also, while I cannot get the controller class documentation comment info

[StingyJack]

What would an aspdotnet controller be equivalent to in an Open API Spec json? I dont think there is any place to put just the controller comments unless they were used as the beginning of each method's comments.

Do you have an example of what you would expect the result to look like?

[WeihanLi]

There's a sample supported by Swashbuckle.AspNetCore
The swagger endpoint is https://reservation.weihanli.xyz/swagger/index.html

From the open API definition(https://reservation.weihanli.xyz/swagger/OpenReservation/swagger.json)
it seemed to be a tag

[StingyJack]

Found this PR that sounds like it was supposed to add support for this. #2949

In the OpenApiDocumentGeneratorSettings add the property UseControllerSummaryAsTagDescription as true and see if that works. If it doesn't, then try setting breakpoints in this code and debugging

[WeihanLi]

Works for me, thank you very much @StingyJack