スワッガーUIの説明

/// <summary> 
    /// This method will retrieve a company in portal 
    /// </summary> 
    /// <param name="UserName">This is the Username assigned to a company to allow service procesing</param> 
    /// <param name="ActualCompanyName">Actual Name of the company</param> 
    /// <returns>This returns a PortalCompany object <see cref="PortalCompany"/> upon successful completion. If a failure arises it will return <see cref="SiteAccessException"/> object. The restful nodes will return</returns> 

    [OperationContract] 
    [WebInvoke(Method = "GET", 
     UriTemplate = "GetCompany/{UserName}/{ActualCompanyName}")] 
    [SwaggerWcf.Attributes.SwaggerWcfPath("Get Company", "Get Company to the portal")] 
    PortalCompany GetCompany(String UserName, String ActualCompanyName);

ここに私の操作契約があります。私はこのセクションの説明を見る必要があります。それが表示されるべきである参照のためにイメージを参照してください。スワッガーUIの説明

Swagger UI

出典

2016-12-16 Athan

あなたは、パラメータの記述ではなく、エンドポイント1を探しています。あなたはどのDataContractプロパティの説明を表示する必要がある場合は

、あなたはそれらにDescriptionAttributeを追加する必要がありますSwaggerWcf

出典

2016-12-16 14:41:46 Fals

感謝：

は

[DataContract(Name = "book")] public class MyContract { [DataMember(Name = "UserName")] [Description("Name of the user")] public string UserName{ get; set; } // [.......] }

あなたはそれらのパラメータのより良いundestandingのドキュメントを見てみる必要がありますあなたはそんなに。価値が必要かどうかはどうですか？ – Athan

@Athan必要なフィールドをカバーするドキュメントには例があります – Fals

ありがとうございます。ああ、実際にはすでにそれは男だった、乾杯。より多くの事をしてください。テキストボックス内の「必須」ラベルを「オプション」に変更するにはどうすればよいですか？ – Athan

答えて

関連する問題