Asp.net Core 2.2 +带有模型的Swagger文档

Question

我们正在使用Asp.net core 2.2开发WebApi，并大摇大摆地向API用户展示文档。

我们有带有请求参数的模型，即搜索

• 查询
• 偏移
• PageSize

为了获得有关swagger 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)

这是它在浏览器中的显示方式

Answer 1

确切地说，您尝试做什么？