Создать описание полей для параметров тела

Question

Так что я много гуглил, чтобы попытаться решить эту проблему, но, похоже, ничего не могу найти по ней. См. Рисунок для справки, но я пытаюсь заполнить поле Описание для параметров тела. Каков наилучший способ сделать это?

Answer 1

Хорошо, так что я понял это, надеюсь, это может помочь кому-то, кто сталкивается с этим. Первое, что вы хотите сделать, это перейти по этой ссылке, чтобы включить XML-документацию для ApiExplorer. После включения вы хотите добавить

/// <summary>Description</summary>

Над вашими именами контроллеров (вы можете добавить имена параметров в xml, добавив еще одну строку <param name="model">A Test Model</param>)

Затем перейдите к своим моделям и для каждого параметра в вашей модели снова добавьте итоговый тег, например:

public class TestModel()
{
/// <summary>This is your IdNumber you received earlier</summary>
public string IdNumber {get;set;}
}

Answer 2

Вы можете добавить атрибут Описание:

[Description("Get the data from our service. It will requires a key.")]
public ActionResult GetData(string key)
{
  //Do something here...
  return Json(new{Success=true, Data = data});
}

Или для параметров

public ActionResult GetData([Description("A valid key should be formated as xxx-xxx-xx")]string key)
{
  //Do something here...
  return Json(new{Success=true, Data = data});
}

От: http://millionbonus.bitbucket.org/mvc.apiexplorer/

Answer 3

Я нашел ответы здесь запутанными, так что вот мое полное решение.

Сначала включите XMLDocumentation, перейдя в Areas -> HelpPage -> App_Start -> HelpPageConfig.cs и раскомментировав следующие две строки.

// Uncomment the following to use the documentation from XML documentation file.
config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml")));

Затем для метода, который вы хотите предоставить документацию для создания комментария XML в следующем формате. Обычно это автозаполнение для меня, но у меня включен репер-харпер, так что это может быть не по умолчанию.

    /// <summary>
    /// An example method description
    /// </summary>
    /// <param name="id">An example parameter description</param>
    /// <returns>An example return value description</returns>
    // GET: api/Products/5
    public string Get(int id)
    {
        return "value";
    }

Если вы запустите приложение и перейдете на страницу справки API, документация должна быть видна.

Answer 4

1. Щелкните правой кнопкой мыши проект, выберите Свойства -> Сборка -> щелкните сборку XML, как показано на рисунке.

2. Перейдите в папку Areas в проекте -> App_Start -> HelpPageConfig.cs

3. Раскомментируйте строку ниже, если она прокомментирована.

   config.SetDocumentationProvider(новый XmlDocumentationProvider (HttpContext.Current.Server.MapPath ("~ / bin / projectname.xml ")));

4. Измените имя файла MapPath на имя, указанное в столбце файла документации Build XML. * имя проекта будет изменено на имя вашего проекта.