ASP.NET Web API Hilfeseite unter separatem Projekt

Question

Ich habe ASP.NET Web API-Projekt, und ich möchte eine Hilfeseite hinzufügen, aber ich möchte, dass es in einem separaten Projekt ist.

Ist es möglich?

Answer 1

Sie können neu schreiben XmlDocumentationProvider Konstruktor etwas wie folgt aus:

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()); 
    } 
} 

es alle XML-Dokumentationsdateien enthalten, die Sie in der Array-Liste. Sie sollten außerdem sicherstellen, dass das Ziel-Web-API-Projekt (und alle Modellprojekte, falls erforderlich) Dokumentation zum Build generiert und an den richtigen Speicherort kopiert.

Answer 2

Sie sollten WebApiConfig.Register von Ihrem Web-API-Projekt in Ihrem Hilfeprojekt nennen:

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