Мы используем ядро Asp.net 2.2 для разработки WebApi и Swagger для отображения документации для пользователей API.
У нас есть модель с параметрами запроса, например, Поиск
Чтобы иметь надлежащую документацию по свагерскому URL, мы сохранили все детали в комментариях над указанной конечной точкой.
Список полей, используемых вмодель отображается, но куда вводить описание, мы пытались войти в сводную вкладку, но не сработало
/// <summary>
/// Search the Inspec database and process your search results in various ways to support your research needs.
/// </summary>
/// /// <remarks>
/// Sample request:
///
/// Get /Search
/// {
/// "Query": "query", //Search Query
/// "Offset": 11, //starts from the 11th record
/// "Size": 10, //Size of the search result
/// "Format": "Extended" //Result to be returned in which type
/// }
///
/// </remarks>
/// <param name="request">Request Params</param>
/// <returns>Search Response <see cref="SearchRequest" /></returns>
/// <response code="200">Returns Successful</response>
/// <response code="400">Returns Bad Request</response>
public async Task<ActionResult<string>> Get([FromQuery]SearchRequest request)
Вот как это отображается в браузере