studio - Documentación de la página de ayuda de ASP.NET Web API utilizando comentarios Xml en los controladores
generar documentacion visual studio 2017 (3)
Instalé el paquete de la página de ayuda de ASP.NET Web API y me gustaría usarlo para generar documentación para mis acciones de controlador de API usando los comentarios Xml que ya están en ellos.
Encontré un artículo en el blog MSDN de Yao en el que analiza cómo se puede generar la documentación en función de los comentarios XML.
Sin embargo, en el método Register de HelpPageConfig , el método SetDocumentationProvider espera que una instancia de XmlDocumentationProvider construya con una ruta física a un archivo de documentación Xml.
Hay otra manera de hacer esto? No tengo claro por qué tengo que apuntar a un archivo de documentación Xml.
Gracias
El XmlDocumentationProvider está buscando el archivo xml (con sus comentarios de código xml) que se genera al compilar su proyecto. Puede habilitar la generación de esto yendo a su proyecto Propiedades -> Construir -> Salida. Seleccione la casilla de verificación para el archivo de documentación XML.
Sé que se responde a esta pregunta, pero en caso de que ayude a alguien, he encontrado esta página porque busco una solución para la documentación de IHttpActionResult
Si todavía tienes problemas, mira los pasos a continuación.
Paso 1 - Agregar comentario en el nivel de controlador
// GET api/documentation
/// <summary>
/// This is how we create a documentation
/// </summary>
/// <returns></returns>
public IEnumerable<string> Get()
Paso 2: construya la página Propiedades del proyecto de propiedad y configure la salida xml para la documentación
Paso 3 - Configuración de HelpPage
Para configurar HelpPageConfig para utilizar nuestro archivo XML de documentación, vaya a ~/Areas/HelpPage/HelpPageConfig.cs .
Por defecto, la declaración config.SetDocumentationProvider está comentada. Use esa declaración y señale la ubicación de DocumentationProvider en nuestro archivo xml:
public static void Register(HttpConfiguration config)
{
// Uncomment the following to use the documentation from XML documentation file.
config.SetDocumentationProvider(
new XmlDocumentationProvider(
HttpContext.Current.Server.MapPath("~/App_Data/Documentation.xml")));
}
EDITAR:
La ubicación de HelpPageConfig en un nuevo proyecto de Web API 2.2 creado en VS2013 es ~/Areas/HelpPage/App_Start/HelpPageConfig.cs