Я занят созданием веб-API (внутри приложения asp mvc4). Я использую библиотеку, предложенную на сайте asp.net для создания документации (http://www.asp.net/web-api/overview/creating-web-apis/creating-api-help-pages).
Моя проблема в том, что если мой параметр является моделью, то я не могу указать, какие свойства содержит модель в сгенерированных страницах справки.
Вот пример:
Модель:
public class TestModel
{
property String FirstName {get;set;}
property String Surname {get; set;}
property Boolean Active {get;set;}
}
ACTION:
/// <summary>
/// This is a test action
/// </summary>
/// <param name="model">this is the model</param> <-- this works
/// <param name="FirstName">This is the first name </param> <-- doesn't work
/// <param name ="model.Surname">This is the surname</param> <-- doesn't work
public HttpResponseMessage Post(my.namespace.models.TestModel model)
{
...
}
Создается только параметр для модели.
Я взглянул на XML-документ, который генерируется для документации, и он добавляет другие параметры.
<member name="my.namespace.api.Post(my.namespace.models.TestModel)">
<summary>
this is a test action
</summary>
<param name="model>this is the model</param>
<param name="FirstName">This is the first name </param>
<param name="model.Surname">This is the surname</param>
</member>
Но на страницах справки он генерирует только модель параметров.
Я проследил его до метода, где он получает параметры из xml.
Collection<ApiDescription> apiDescriptions = config.Services.GetApiExplorer().ApiDescriptions;
Это находится в файле HelpPageConfigurationExtentions.cs, который сгенерирован автоматически.
Я подхожу к этому неправильно? Кто-нибудь знает о работе?
Любые предложения или решения будут оценены.