3

ドキュメントを提供するためにWebAPI ヘルプ ページを使用しています。ドキュメントは、URI で複雑なモデルを使用する場合を除いて、(xml コメントから) 正常に生成されます。だから、私は次のドキュメントを取得します

GET service/Tst2    No documentation available.

メソッドの場合:

    /// <summary>
    /// description
    /// </summary>
    [HttpGet]
    public string Tst([FromUri] TstModel filter)
    {
        return null;
    }

    public class TstModel
    {
        public int Id { get; set; }
    }

単純な int/string パラメーターを持つ他のメソッドでは、期待どおりに機能します。[FromUri]属性を削除しても機能しますが、その後

問題は、そのようなメソッドのドキュメントを表示するにはどうすればよいかということです。URI から取得した複合型のドキュメントを提供するにはどうすればよいですか?

4

2 に答える 2

3

[FromUri] 属性で装飾された複合型のヘルプが生成されないという最初の質問については、既知の問題であり、現在取り組んでいます。

于 2013-03-14T16:35:09.780 に答える
3

「No documentation available」と出力された理由。これは、私のTstModelクラスがネストされたクラス (コントローラー内で定義されている) であり、WebAPI ヘルプが xml コメントを見つけるための間違った XPath を生成したためです。TstModelコントローラーからの移動が役立ちました。

PSヘルプページコードの修正は簡単です。バグと修正をどこに報告すればよいかわかりません(現時点ではNuGetで書いています):)

これは：XmlDocumentationProvider.GetTypeName

109行目:return type.FullName.Replace("+", "."); //was: return type.FullName

そして101行目： string typeName = genericType.FullName.Replace("+", "."); //was: string typeName = genericType.FullName

于 2013-03-14T14:30:30.477 に答える