Web APIのXmlドキュメントに、メインプロジェクト以外のドキュメントをどのように含めることができますか？

XmlDocをWeb Apiプロジェクトに統合できるようにするためのドキュメントは、すべてのAPIタイプがWebApiプロジェクトの一部である状況のみを処理するように見えます。特に、XMLドキュメントを再ルーティングして、App_Data/XmlDocument.xmlそのファイルを使用する構成内の行のコメントを外す方法について説明します。これは暗黙的に1つのプロジェクトのドキュメントファイルのみを許可します。

ただし、私のセットアップでは、リクエストとレスポンスのタイプを共通の「モデル」プロジェクトで定義しています。つまり、次のようなエンドポイントが定義されている場合、

[Route("auth/openid/login")]
public async Task<AuthenticationResponse> Login(OpenIdLoginRequest request) { ... }

どこにOpenIdLoginRequestそのような個別のC＃プロジェクトで定義されます。

public class OpenIdLoginRequest
{
    /// <summary>
    /// Represents the OpenId provider that authenticated the user. (i.e. Facebook, Google, etc.)
    /// </summary>
    [Required]
    public string Provider { get; set; }

    ...
}

XML doccommentsにもかかわらず、requestエンドポイント固有のヘルプページ（つまりhttp://localhost/Help/Api/POST-auth-openid-login）を表示すると、パラメーターのプロパティにはドキュメントが含まれません。

XMLドキュメントを含むサブプロジェクトの型がWeb API XMLドキュメントに表示されるようにするにはどうすればよいですか？

これを実現する組み込みの方法はありません。ただし、必要な手順はわずかです。

1. Web APIプロジェクトの場合と同様に、（プロジェクトプロパティ/ビルドから）サブプロジェクトのXMLドキュメントを有効にします。今回以外は、直接ルーティングしてXmlDocument.xml、プロジェクトのルートフォルダーに生成されるようにします。

2. Web APIプロジェクトのポストビルドイベントを変更して、このXMLファイルをApp_Dataフォルダーにコピーします。

   copy "$(SolutionDir)SubProject\XmlDocument.xml" "$(ProjectDir)\App_Data\Subproject.xml"

   where Subproject.xmlは、プロジェクトの名前がplusであるものに名前を変更する必要があります.xml。

3. 次にAreas\HelpPage\App_Start\HelpPageConfig、次の行を開いて見つけます。

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

   これは、最初にXMLヘルプドキュメントを有効にするために最初にコメントを外した行です。その行を次で置き換えます：

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

   この手順によりXmlDocumentationProvider、プロジェクトの特定のXMLファイルではなく、XMLファイルを含むディレクトリが確実に渡されます。

4. 最後Areas\HelpPage\XmlDocumentationProviderに、次の方法で変更します。

   a。_documentNavigatorフィールドを次のものに置き換えます。

   private List<XPathNavigator> _documentNavigators = new List<XPathNavigator>();

   b。コンストラクタを次のものに置き換えます。

   public XmlDocumentationProvider(string appDataPath)
   {
       if (appDataPath == null)
       {
           throw new ArgumentNullException("appDataPath");
       }
   
       var files = new[] { "XmlDocument.xml", "Subproject.xml" };
       foreach (var file in files)
       {
           XPathDocument xpath = new XPathDocument(Path.Combine(appDataPath, file));
           _documentNavigators.Add(xpath.CreateNavigator());
       }
   }
   

   c。コンストラクタの下に次のメソッドを追加します。

   private XPathNavigator SelectSingleNode(string selectExpression)
   {
       foreach (var navigator in _documentNavigators)
       {
           var propertyNode = navigator.SelectSingleNode(selectExpression);
           if (propertyNode != null)
               return propertyNode;
       }
       return null;
   }
   

   d。最後に、すべてのコンパイラエラーを修正し（3つ存在する必要があります）_documentNavigator.SelectSingleNode、その_documentNavigator.部分を参照して削除し、SelectSingleNode上記で定義した新しいメソッドを呼び出すようにします。

この最後のステップでは、ドキュメントプロバイダーを変更して、プライマリプロジェクトだけでなく、複数のXMLドキュメント内でヘルプテキストを探すことをサポートします。

ヘルプドキュメントを調べると、関連プロジェクトのタイプのXMLドキュメントが含まれています。

私もこれに遭遇しましたが、後で問題が発生するのを防ぐために、生成されたコードを編集したり複製したりしたくありませんでした。

他の答えに基づいて、複数のXMLソース用の自己完結型ドキュメントプロバイダーを次に示します。これをプロジェクトにドロップするだけです：

/// <summary>A custom <see cref="IDocumentationProvider"/> that reads the API documentation from a collection of XML documentation files.</summary>
public class MultiXmlDocumentationProvider : IDocumentationProvider, IModelDocumentationProvider
{
    /*********
    ** Properties
    *********/
    /// <summary>The internal documentation providers for specific files.</summary>
    private readonly XmlDocumentationProvider[] Providers;


    /*********
    ** Public methods
    *********/
    /// <summary>Construct an instance.</summary>
    /// <param name="paths">The physical paths to the XML documents.</param>
    public MultiXmlDocumentationProvider(params string[] paths)
    {
        this.Providers = paths.Select(p => new XmlDocumentationProvider(p)).ToArray();
    }

    /// <summary>Gets the documentation for a subject.</summary>
    /// <param name="subject">The subject to document.</param>
    public string GetDocumentation(MemberInfo subject)
    {
        return this.GetFirstMatch(p => p.GetDocumentation(subject));
    }

    /// <summary>Gets the documentation for a subject.</summary>
    /// <param name="subject">The subject to document.</param>
    public string GetDocumentation(Type subject)
    {
        return this.GetFirstMatch(p => p.GetDocumentation(subject));
    }

    /// <summary>Gets the documentation for a subject.</summary>
    /// <param name="subject">The subject to document.</param>
    public string GetDocumentation(HttpControllerDescriptor subject)
    {
        return this.GetFirstMatch(p => p.GetDocumentation(subject));
    }

    /// <summary>Gets the documentation for a subject.</summary>
    /// <param name="subject">The subject to document.</param>
    public string GetDocumentation(HttpActionDescriptor subject)
    {
        return this.GetFirstMatch(p => p.GetDocumentation(subject));
    }

    /// <summary>Gets the documentation for a subject.</summary>
    /// <param name="subject">The subject to document.</param>
    public string GetDocumentation(HttpParameterDescriptor subject)
    {
        return this.GetFirstMatch(p => p.GetDocumentation(subject));
    }

    /// <summary>Gets the documentation for a subject.</summary>
    /// <param name="subject">The subject to document.</param>
    public string GetResponseDocumentation(HttpActionDescriptor subject)
    {
        return this.GetFirstMatch(p => p.GetResponseDocumentation(subject));
    }


    /*********
    ** Private methods
    *********/
    /// <summary>Get the first valid result from the collection of XML documentation providers.</summary>
    /// <param name="expr">The method to invoke.</param>
    private string GetFirstMatch(Func<XmlDocumentationProvider, string> expr)
    {
        return this.Providers
            .Select(expr)
            .FirstOrDefault(p => !String.IsNullOrWhiteSpace(p));
    }
}

...そして、必要なHelpPageConfigXMLドキュメントへのパスを使用してそれを有効にします。

config.SetDocumentationProvider(new MultiXmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/Api.xml"), HttpContext.Current.Server.MapPath("~/App_Data/Api.Models.xml")));

これを行うもう1つの簡略化された方法は、xmlファイルをマージすることです。以下の返信のコード例：

複数のファイルからのWeb APIヘルプページのXMLコメント

ここに私はあなたを助けることができるそれとの回答リンクを提供します。文書化のために複数のXMLファイルを簡単に使用できます。

複数のファイルからのWeb APIヘルプページのXMLコメント

この問題を修正する最も簡単な方法は、デプロイしたサーバーにApp_Codeフォルダーを作成することです。次に、binフォルダーにあるXmlDocument.xmlをローカルでApp_Codeフォルダーにコピーします。