5

Web APIヘルプページジェネレータでAPIドキュメントを生成しています。しかし、問題は、ヘルプページジェネレータがEnumパラメータを持つメソッドのドキュメントを生成できないことです。これは、オブジェクトと動的型のパラメータでも発生します。ここで Web 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. 

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

答えて

3

これは実際には今年4月に修正されたバグでした。以下はその問題です。

http://aspnetwebstack.codeplex.com/workitem/312

+0

Nugetは更新されていません。ソースを更新するにはどうしたらいいですか? –

+1

RC(リリース候補)が今日リリースされました。ナゲットパッケージをアップグレードして、問題が修正されているかどうかを確認することができます。 –

+0

まだ動作していません。すべてのAspNetパッケージを使用可能なバージョン4.0.30506.0に更新しました。 –

4

私は単にGetTypeName(Type type)メソッド内XmlDocumentationProvider.csに次のコードを追加することで解決しました私の最後に同様の問題がありました。

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

私の列挙型は、一つの大きな列挙型クラスの下にあるすべてであり、問​​題は、この関数は、XMLファイルに見つかりませんでした列挙型+ MyEnumを返したことでした。オフコースでは、探すべき値はEnums.MyEnumです。

+0

これは私にとってはうまくいきました。ウェブAPI用の最新のナゲットを実行していました。 –

+0

私の問題も解決しました。説明が私のために表示されていないb/c彼らはタイプ名が一致しなかった(+対。)。ありがとう! – Darky711

関連する問題