27

ASP.NET Web APIヘルプページパッケージをインストールしました。これを使用して、既に含まれているXmlコメントを使用してAPIコントローラーアクションのドキュメントを生成したいと思います。

YaoのMSDNブログで、XMLコメントに基づいてドキュメントを生成する方法について説明している記事に出くわしました。

ただし、のRegisterメソッドではHelpPageConfig、このメソッドは、Xmlドキュメントファイルへの物理パスSetDocumentationProviderで構築されたインスタンスを想定しています。XmlDocumentationProvider

これを行う別の方法はありますか？Xmlドキュメントファイルを指す必要がある理由がわかりません。

ありがとう

4

3 に答える 3

44

それでも問題が解決しない場合は、以下の手順を参照してください。

ステップ 1 - コントローラー レベルでコメントを追加する

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

ステップ 2 - プロパティ プロジェクト プロパティ ページをビルド し、ドキュメント用の xml 出力を設定する

ここに画像の説明を入力

ステップ 3 - HelpPage 設定

ドキュメント xml ファイルを使用するように HelpPageConfig を設定するには、 にアクセスしてください~\Areas\HelpPage\HelpPageConfig.cs。

デフォルトでは、config.SetDocumentationProvider ステートメントはコメント化されています。そのステートメントを使用して、DocumentationProvider の場所を 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")));
}

編集：

VS2013 で作成された新しい Web API 2.2 プロジェクトの HelpPageConfig の場所は次のとおりです。~\Areas\HelpPage\App_Start\HelpPageConfig.cs

于 2015-09-24T06:43:23.710 に答える
29

XmlDocumentationProvider は、プロジェクトのコンパイル時に生成される xml ファイル (xml コード コメントを含む) を探しています。これを有効にするには、プロジェクトの [プロパティ] -> [ビルド] -> [出力] に移動します。ここで、XML ドキュメント ファイルのチェックボックスを選択します。

于 2013-02-12T23:17:32.730 に答える