He instalado el ASP.NET API Web de la Página de Ayuda paquete y me gustaría utilizarlo para generar documentación de la API de controlador de acciones mediante el uso de Xml comentarios ya sobre ellos.

Me encontré con un artículo sobre Yao del blog de MSDN donde se discute cómo la documentación puede ser generada a partir de los comentarios XML.

Sin embargo, en el método de Registro de HelpPageConfig, el SetDocumentationProvider método espera una instancia de XmlDocumentationProvider construido con una ruta de acceso física a un archivo de documentación Xml.

Hay otra manera de hacer esto? No me queda claro por qué tengo que apuntar a un archivo de documentación Xml.

Gracias

InformationsquelleAutor George Durzi | 2013-02-12

3 Comentarios

  1. 27

    La XmlDocumentationProvider está buscando el archivo xml(tener su código xml comentarios) que se genera al compilar el proyecto.
    Puede habilitar la generación de esta yendo a las Propiedades del proyecto -> Construir -> la Salida. Aquí seleccione la casilla de verificación del archivo de Documentación XML.

    • Kiran, gracias, este es el truco. Hay una buena manera de obtener acceso mediante programación a este valor en tiempo de ejecución? Ahora mismo estoy haciendo HttpContext.Actual.Servidor.MapPath …
    • muchas gracias por esta respuesta, finalmente descubierto la manera de conseguir este trabajo.
    • Sigue igual, sigo sin ver «No hay documentación disponible»
  2. 38

    Si sigue el problema, a continuación, consulte los pasos siguientes.

    Paso 1 – Agregar comentario en el controlador de nivel

    //GET api/documentation
    ///<summary>
    ///This is how we create a documentation
    ///</summary>
    ///<returns></returns>
    public IEnumerable<string> Get()
    

    Paso 2 – Creación De Propiedad
    Página de Propiedades del proyecto y establecer el xml de salida para la documentación

    ASP.NET el API Web de la Página de Ayuda de la documentación mediante el uso de Xml comentarios sobre los controladores

    Paso 3 – HelpPage Config

    Para configurar el HelpPageConfig utilizar nuestro xml de documentación de archivo, vaya al ~\Areas\HelpPage\HelpPageConfig.cs.

    De forma predeterminada, el archivo de configuración config.SetDocumentationProvider declaración está comentado. El uso de esa declaración, y el punto de la ubicación de DocumentationProvider a 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")));
    }
    

    EDICIÓN:

    La ubicación de la HelpPageConfig en una nueva API de Web 2.2 proyecto creado en VS2013 es ~\Areas\HelpPage\App_Start\HelpPageConfig.cs

    • La ubicación de la HelpPageConfig en una nueva API de Web 2.2 proyecto creado en VS2013 es ~\Áreas\HelpPage\App_Start\HelpPageConfig.cs
    • Gracias por la aclaración

Dejar respuesta

Please enter your comment!
Please enter your name here