Pagina di aiuto dell'API Web ASP.NET in un progetto separato

Question

Ho un progetto API Web ASP.NET e desidero aggiungere una pagina di Guida, ma desidero che si trovi in ​​un progetto separato.

È possibile?

Answer 1

È possibile riscrivere XmlDocumentationProvider costruttore per una cosa del genere:

public XmlDocumentationProvider(string appDataPath) 
{ 
    if (appDataPath == null) 
    { 
     throw new ArgumentNullException(nameof(appDataPath)); 
    } 

    var files = new[] { "MyWebApiProject.xml" /*, ... any other projects */ }; 
    foreach (var file in files) 
    { 
     var xpath = new XPathDocument(Path.Combine(appDataPath, file)); 
     _documentNavigators.Add(xpath.CreateNavigator()); 
    } 
} 

Esso comprenderà tutti i file di documentazione XML che si elencare nella matrice. Dovresti anche assicurarti che il tuo progetto API Web di destinazione (e tutti i progetti del modello, se necessario) generi documentazione sulla build e copi nel posto giusto.

Answer 2

Si dovrebbe chiamare WebApiConfig.Register dal progetto API Web nel progetto di aiuto:

protected void Application_Start() 
    { 
    AreaRegistration.RegisterAllAreas(); 
    RouteConfig.RegisterRoutes(RouteTable.Routes); 
    GlobalConfiguration.Configure(MyApiProjectNamespace.WebApiConfig.Register); 
    }