如何在 swagger ui 中添加其他響應代碼？

Question

我通過在我的 pom.xml 中導入開放 API 依賴項創建了一個 API 規范文檔，但是在生成的 swagger UI 界面中，我的模式僅可用於 200 個響應我是否需要手動添加其他響應或 swagger 可以自動生成它

Answer 1

您需要在映射中添加 @ApiResponses 注釋，例如：

@GetMapping("/example")
@ApiOperation(value = "Example mapping")
@ApiResponses(value = {@ApiResponse(code = 200, message = "Successfull request"), @ApiResponse(code = 500, message = "Internal error")})
public void example() {
 // example
}

Answer 2

通常，Swagger UI 也有一些默認響應代碼，任何 API 都可以像這樣拋出：

但是，如果您看不到任何響應代碼，那么您可以使用以下代碼為不同的 API 配置響應代碼：

@ApiResponses(value = {@ApiResponse(code = 500, message = "Internal Server Error")})
public class Controller { 

    @ApiResponses(value = {@ApiResponse(code = 404, message = "Resource Not Found"), @ApiResponse(code = 200, message = "Ok")}) 
    public ResponseEntity<> listApi(){
      // Code here
    }
}

使用也可以在類級別使用@ApiResponses注解，如果您有跨多個 API 的一些通用響應代碼。