Skip to content
Rico Suter edited this page Sep 4, 2018 · 20 revisions

The JsonSchemaGenerator automatically loads .NET XML Documentation files to populate the JSON Schema/Swagger/OpenAPI attributes summary, description and others. The XML file is searched in the directory of the type's assembly with the assembly file name but with the file extension .xml. This xmlfile is only generated when enabled in the project settings.

The XML Documentation reader uses reflection to support multiple platforms in a single PCL. In order to work, following types must be available:

  • System.IO.File
  • System.IO.Path
  • System.Xml.XPath.Extensions

.NET Core

To make the required types available in a .NET Core process (i.e. in your ASP.NET Core application), you may need to install the following NuGet packages:

Clone this wiki locally