6

Web API ヘルプ ページ ジェネレーターを使用して API ドキュメントを生成しています。しかし問題は、ヘルプ ページ ジェネレーターが Enum パラメーターを持つメソッドのドキュメントを生成できないことです。これは、オブジェクトおよび動的タイプのパラメーターでも発生します。

これが私の方法です：

public HttpResponseMessage Get(Status status, DateTime? date = null)
{
    ...
}

enum Status
{
    Avaliable,
    Busy,
    Canceled,
    Failed,
    Sent
}

そして、ここにドキュメントの生成があります：

GET api/StatusCheck?date={date}

しかし、正しい形式は次のとおりです。

GET api/StatusCheck?status={status}&date={date}

API モデルのドキュメントにアクセスすると、パラメーターはありますが、説明がありません。

こんな感じです：

GET api/StatusCheck?date={date}

Unavaliable.

Request
Parameters

Name            Description
status          Unavaliable.
date            Unavaliable.

これはヘルプ ページ ジェネレーターのバグですか? ページの例を修正するにはどうすればよいですか?

4

2 に答える 2

3

最後に同様の問題がありましたが、メソッド内の XmlDocumentationProvider.cs に次のコードを追加するだけで解決されましたGetTypeName(Type type)。

if (type.IsEnum) { return type.FullName.Replace("+", "."); }

私の列挙型はすべて 1 つの大きな列挙型クラスの下にあり、問題は、この関数が Xml ファイルに見つからない Enums+MyEnum を返すことでした。もちろん、探すべき値は Enums.MyEnum です。

于 2013-12-20T22:46:23.993 に答える