2016-12-16 2 views
0
/// <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); 

Настоящий контракт с моей операцией. Мне нужно просмотреть описание в этом разделе. См. Изображение для справки, где оно должно появиться.Swagger UI Описание

Swagger UI

ответ

0

Вы ищете описание параметров, а не конечной точкой одного.

Если вам нужно показать описание на любом DataContract собственности, вам следует добавить DescriptionAttribute на них:

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

    // [.......] 
} 

Вы должны взглянуть на документации для лучших допер эти параметры: SwaggerWcf

+0

Спасибо Ты так много. Как насчет того, требуется ли значение или нет? – Athan

+0

@Athan есть пример в документах, покрывающих обязательные поля – Fals

+0

Спасибо. Да, на самом деле он уже сделал это, Cheers. Побольше, пожалуйста. Как изменить метку «Обязательный» внутри текстового поля на «Необязательный», например? – Athan

Смежные вопросы