XML comments file could not be found - Swagger

Question

This is certainly one of those that drives you nuts. As the title indicates all I'm simply trying to do is display comments pulled from an xml file using swagger.

I appear to have taken all steps according to the swagger documentation but to no avail. Hopefully you kind folk can point me in the right direction.

Steps Taken:

Ensured file exists:

Configured SwaggerConfig.cs

I've tried changing the path too: @"bin/....xml"

Nothing seems to work.

**The Error "Could not find file": **

Can anyone point me in the right direction please?

Regards,

Answer 1

in .net core 3.0

<GenerateDocumentationFile>true</GenerateDocumentationFile> 

in PropertyGroup tag of .csproj file

Answer 2

These are the steps I needed in .Net Core 2.2:

Put this in Startup.cs:

    public void ConfigureServices(IServiceCollection services)     {          ...          // Register the Swagger generator, defining 1 or more Swagger documents         services.AddSwaggerGen(c =>             {                 ...                  var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";                 var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);                 c.IncludeXmlComments(xmlPath);             });     } 

Edit your .csproj file and add / change these nodes:

  <PropertyGroup>     ...     <!--      Make sure documentation XML is also included when publishing (not only when testing)     see https://github.com/Azure/service-fabric-issues/issues/190     -->     <GenerateDocumentationFile>true</GenerateDocumentationFile>   </PropertyGroup>    <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">     ...     <DocumentationFile>bin\$(Configuration)\$(AssemblyName).xml</DocumentationFile>   </PropertyGroup>