c# - メディア タイプ 'application/x-www-form-urlencoded' のサンプルを生成できませんでした

Question

最近、ASP.net Web API の作成を開始しました

自動生成されたヘルプ ドキュメントを表示すると、何らかの理由で次のエラーが表示され続けます。

これは POST メソッド用です

application/json および application/xml のサンプルは正常に表示されます

よくわかりませんが、 application/-x-www-form-urlencoded が表示され続けます

エラーをかなりグーグルで検索しましたが、これを引き起こしている可能性のあるものを見つけることができません

ご不明な点がございましたら、お気軽にお問い合わせください。

Answer 1

これは予期される動作です。HelpPage のサンプル生成では、HttpConfiguration に存在する実際のフォーマッタを使用して、サンプル オブジェクトを「書き込み」ます。FormUrlEncodedMediaTypeFormatter はどのタイプも「書き込む」ことができないため、HelpPage はそのサンプルを生成できません。回避策として、特定のタイプのサンプルを明示的に提供することができます (Areas\HelpPage\App_Start\HelpPageConfig.cs のコメント付きコードに示されているように)。

config.SetSampleForType("[0]=foo&[1]=bar", new MediaTypeHeaderValue("application/x-www-form-urlencoded"), typeof(IEnumerable<string>));

Answer 2

答えは私を助けましたが、システムが知らなかった各タイプの例を書くのに飽きました...私がやったことはこれです

Type[] types = { typeof(MyType), typeof(AnotherType), *add more here* };

foreach(Type t in types)
{
    List<string> propExample = new List<string>();
    foreach(var p in t.GetProperties())
    {
        propExample.Add(p.Name + "=value");
    }

    config.SetSampleForType(string.Join("&", propExample), new MediaTypeHeaderValue("application/x-www-form-urlencoded"), t);            
}

誰かが賢く拡張して、プロパティのタイプに基づいてデフォルト値を設定できるようにすることもできますが、私の目的にはこれで十分でした。