2017-06-08 5 views
0

をSwashbuckleを使用することが操作に渡さ説明個々のパラメータを生成するswashbuckle取得するには非常に簡単ですが、私はこのようなモデルに渡す場合:モデルプロパティを文書化する

public void Put([FromUri] ViewModelTest viewModelTest) 
{ 
} 

とモデルは次のようになります。

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

    public string Name { get; set; } 
} 

モデルの説明を入力するための推奨戦略はありますか?ここで

enter image description here

答えて

0

実施例である: http://swashbuckletest.azurewebsites.net/swagger/ui/index#!/TestEnum/TestEnum_Get

とコードはGitHubの上にある:あなたは https://github.com/heldersepu/SwashbuckleTest/blob/master/Swagger_Test/Controllers/TestEnumController.cs

...そして、あなたの闊歩の設定で(App_Start/SwaggerConfig.cs) IncludeXmlCommentsを有効にする必要があります

+0

返信ありがとうございますが、この例では1つのパラメータを渡すだけです。上記のように、docはかなり簡単ですコントローラーアクションの上にxmlコメントを付けてこれをメモしてください。私ができるようにしたいのは、渡されたモデル(POCO)のフィールドを文書化することです。 – Mattl

+0

はい、例のようにxmlコメントが必要です。 – HelderSepu

+0

あなたのモデルは次のようになりますxmlコメント: http://swashbuckletest.azurewebsites.net/swagger/ui/index#!/TestEnum/TestEnum_Put – HelderSepu

関連する問題