www.jucaripo.com

Documentar API en ASP.NET MVC5

este tutorial es para Visual estudio 2013 con el template  de MVC5 Web API

 

Paso 1

Crear un proyecto con Web Api

create web api

 

 

Paso 2

ir a Areas/HelpPage/HelpPageConfig.cs

Area HelpPage

 

paso 3

al abrir el archivo  vamos a la siguiente linea (“esta normalmente en la linea 37”) y le vamos a quitar los comentarios.

// config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath(“~/App_Data/estraDG-API.xml”)));

 

Paso 4

Ir en propiedades del proyecto a la pestaña buil y activar xml documentation  para que permita generar el xml de la ayuda

properties

 

en XML documentation File  ponemos App_Data/NombreArchivo.XML que se utilizara para la codumentación.

 

Paso 5

Regresamos al archivo HelpPageConfig.cs  y pegamos la ruta

que creamos en el paso 4

ya que este es el xml que usara visual estudio para generar la doumentación y  eso es todo para tener activo el autodocumentar en visual estudio.

 

 

 

Comentarios

Deja un comentario

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

Escribe un comentario