XML Documentation

Rico Suter edited this page May 14, 2018 · 5 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.

The XML Documentation reader uses reflection to support multiple platforms in a single PCL. In order to work, the 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 need to install the following NuGet packages: