1

API ヘルプ ページのドキュメントを必要とするプロジェクトに取り組んでいます。ページはすでに作成されており、情報を挿入する準備ができています。しかし、私はいくつかの問題があります:

  1. 私はこれに非常に慣れていないため、プロジェクトをナビゲートする際にいくつかの問題があります。

  2. 次のように、Controller ファイル内にある XML コメントを直接参照したいと考えています。

    /// <summary>
/// Get all the number of help desk tickets by their current priorities
/// </summary>
/// <returns></returns>


[ActionName("GetCurrentPriority")]
public TicketPriorities GetTicketsByCurrentPriority()
{...

WebApiConfig.cs ファイルの HTTP ルート コードは次のようになります。

            config.Routes.MapHttpRoute(
            name: "DefaultApi",
            routeTemplate: "api/{controller}/{action}/{id}",
            defaults: new { id = RouteParameter.Optional }
        );

しかし、Web ヘルプ ページにコメントを投稿する方法がわかりません。パラメータ ID が使用されている多くの例を見てきましたが、ID がないように見えます。また、ヘルプ ページには ID 以外のすべてが表示されるため、パラメータ ID の検索方法や作成方法がわかりません。たとえば、XMLDocument.xmlファイルを作成して、そこにすべてのコメントを入れる必要がありますか?

4

1 に答える 1

3

このコード行はありますか?

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

また、[プロジェクト プロパティ] -> [ビルド] で [XML ドキュメント ファイル] にチェックを入れることを忘れないでください。へのパスを設定しますApp_Data\XmlDocument.xml。

publicドキュメントを追加する必要のないクラス (ヘルプ生成コードなど) がたくさんあるため、警告 CS1591 を抑制したい場合もあります。

詳細については、次のドキュメントを参照してください: http://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/creating-api-help-pages

于 2015-04-14T02:15:09.680 に答える