Как подробно описать возвращаемые значения в Swagger.NET?

У меня есть веб-служба REST Web API, которая возвращает объекты. Я установил Swagger.NET, а также пользовательский интерфейс Swagger. Я бы хотел, чтобы пользовательский интерфейс Swagger отображал поля внутри объектов, возвращаемых из методов REST веб-API. Это возможно?

Из документации Swagger Swagger.NET использует ApiExplorer для сбора информации о конечных точках веб-API, которые у меня есть (классы, расширяющие ApiController). Кроме того, Swagger.NET просматривает комментарии к документам .NET (используя '///'). Я не уверен, как описать внутренности этих объектов.

Любые идеи?

Спасибо.


person Jon Onstott    schedule 24.04.2013    source источник


Ответы (1)


Это не поддерживается в настоящее время из коробки. С этим связана следующая проблема. Вы можете проголосовать за это: http://aspnetwebstack.codeplex.com/workitem/877

person Kiran Challa    schedule 24.04.2013
comment
Есть ли способ прокомментировать внутренности объекта, возвращаемого Swagger? Я хотел бы иметь клиент Java с кодом, сгенерированным Swagger-Codegen. - person Jon Onstott; 24.04.2013