2015-08-25 11 views
7

ho installato il pacchetto da NuGet, senza commenti la linea da HelpPageConfig.cs-ASP.Net Web API Aiuto Pagina - nessun contenuto

config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml"))); 

ho impostato lo stesso file in Proprietà-> Build-> XML file di documentazione, Aggiunto un nuovo file Global.asax.cs in cui io chiamo per l'iscrizione per tutte le aree sotto metodo Application:

protected void Application_Start(object sender, EventArgs e) 
{ 
    AreaRegistration.RegisterAllAreas(); 
} 

ho aggiunto un po 'di sintesi per alcuni dei miei controllori:

public class IncidentsController : ApiController 
{ 
    /// <summary> 
    /// this is the summary 
    /// </summary> 
    /// <param name="incidentId">this is incidentId</param> 
    /// <returns>it returns something</returns> 
    [Route("{incidentId}")] 
    [HttpGet] 
    public object GetIncidentById(int incidentId) 
    { 
      return Incidents.SingleOrDefault(i => i.id == incidentId); 
    } 
} 

quando ho eseguito la pagina web e vado a '/ help' l'unica cosa che vedo è

ASP.NET Web API Aiuto Pagina

Introduzione

fornire una descrizione generale del le tue API qui.

e una pagina vuota dopo che ...

ho cercato di eseguire il debug di questo e in HelpController.cs in:

public ActionResult Index() 
{ 
      ViewBag.DocumentationProvider = Configuration.Services.GetDocumentationProvider(); 
      return View(Configuration.Services.GetApiExplorer().ApiDescriptions); 
} 

Non ottengo ApiDescriptions.

cosa mi manca? Apprezzerò qualsiasi aiuto!

risposta

0

Hai mappato XMl Path giusto?

Hai aggiunto un riepilogo ai tuoi metodi? /// /// Ottiene alcuni dati molto importanti dal server. ///

Questo dovrebbe aiutare Hai controllato WebApi Help Page Description

13

sono stato in grado di risolvere questo con l'aggiunta di GlobalConfiguration.Configure (WebApiConfig.Register); nel mio metodo Application_Start(). Poiché la mia applicazione utilizza OWIN, registravo le mie API solo in Startup.Configuration (IAppBuilder app).

+1

GRAZIE !! Questo era il mio problema esatto e la tua risposta l'ha risolto per me! – edicius6

+0

Anche questo era il mio problema. Grazie! –

+0

Sei una manna dal cielo! GRAZIE!! – adamtoakley