asp.net-web-api - and - web api rest c#
Página de ayuda de Web Api: no escatime html en la documentación xml (2)
En el archivo XmlDocumentationProvider.cs instalado en Areas/HelpPage , puede buscar un método llamado ''GetTagValue'' ... aquí modifique el valor de retorno de ''node.Value.Trim ()'' a ''node.InnerXml''.
private static string GetTagValue(XPathNavigator parentNode, string tagName)
{
if (parentNode != null)
{
XPathNavigator node = parentNode.SelectSingleNode(tagName);
if (node != null)
{
return node.InnerXml;
}
}
return null;
}
Ahora abra el archivo instalado Areas/HelpPage/Views/Help/DisplayTemplates/ApiGroup.cshtml y modifique la siguiente línea desde:
<p>@controllerDocumentation</p>
a
<p>@Html.Raw(controllerDocumentation)</p>
Estoy utilizando la documentación XML para mi página de ayuda de ASP.NET Web API como se muestra aquí . Me gustaría saber si hay una forma de incluir html en los comentarios de manera que se represente en la página web, en lugar de eliminarlo, ignorarlo o escapar.
Específicamente, estoy buscando una forma de crear una nueva línea, pero ser capaz de crear listas con viñetas, etc. ¡sería genial!
Ex / I quisiera poder hacer algo como esto:
/// <summary>
/// CRUD operations for SalesDocument<br/>
/// This is a new line
/// </summary>
[RoutePrefix("api/SalesDocument")]
public partial class SalesDocumentController : ApiController
Y haz que se muestre en la página de ayuda de esta manera:
CRUD operations for SalesDocument
This is a new line.
En lugar de esto: (en este caso, <br/> se elimina de alguna manera; si intento usar etiquetas <p> , simplemente se escapan)
CRUD operations for SalesDocument This is a new line.
* Ya he probado la etiqueta <para> como lo sugieren las publicaciones múltiples para la información sobre herramientas, pero esto no funciona en mi página de ayuda.
¡Cualquier sugerencia es bienvenida!
@controllerDocumentation no funciona para mí, pero cambiar la línea a @api.Documentation funciona. es decir, @html.raw(api.Documentation) .