使用Swagger的特定状态代码的响应模型-Java 学习之路

我正在使用Swagger来记录我的REST API（使用asp.net web api 2） . 对于给定的api调用，是否有一种方法可以为每个可能的响应提供响应模型？我正在使用xml注释来注释状态代码响应，如下所示：

/// <summary>
    /// Save a person
    /// </summary>
    /// <response code="200">Ok</response>
    /// <response code="400">Bad Request</response>
    /// <response code="500">Internal Server error</response>
    public HttpResponseMessage SavePerson() {...}

enter image description here

3 回答

你可以试试

[SwaggerResponse(200, typeof(CustomModel))]

并且您还要为该响应类型添加注释作为可选的第三个参数

[SwaggerResponse(200, typeof(CustomModel), "returns a new id of the bla bla")]

回复于 2024-05-06T20:20:56+08:00

5
您可以尝试在XML评论中使用cref =“TYPE HERE” .
```
/// <response code="400" cref="CustomErrorModel">Bad Request</response>
```
我会建议使用Swagger给你的注释 .
```
[SwaggerResponse(HttpStatusCode.OK, Type = typeof(OnlineMerchantQueryResponseInformation))]
```
使用此属性控制您的控制器 .
回复于 2024-05-06T20:20:56+08:00
25
您的签名表示您正在返回HttpResponseMessage，而不是数据模型 . 如果您要返回IActionResult，则可以使用“ProducesResponseType”属性 .
```
[ProducesResponseType(typeof(IEnumerable<YourModel>), 200)]
```
ProducesResponsesType位于Microsoft.AspNetCore.Mvc命名空间中 .

见https://github.com/domaindrivendev/Swashbuckle.AspNetCore#list-operation-responses "Explicit Responses"
回复于 2024-05-06T20:20:56+08:00

使用Swagger的特定状态代码的响应模型

3 回答

相关问题