当前位置: 首页 > 知识库问答 >
问题:

招摇过市-Springfox总是生成一些响应消息(401403…)默认情况下。我怎样才能移除它们?

王才英
2023-03-14

我有这样简单的控制器:

java prettyprint-override">@RequestMapping(value="/async/data", method=RequestMethod.GET, produces="application/json")
@ApiOperation(value = "Gets data", notes="Gets data asynchronously")
@ApiResponses(value={@ApiResponse(code=200, message="OK")})
public Callable<List<Data>> getData(){
    return ( () -> {return dataService.loadData();} );
}

我原以为只有HTTP状态200的响应消息。然而,springfox总是生成下面的(401, 403, 404)。如何禁用(不显示)它们?

async-rest-controller Show/Hide List Operations Expand Operations
GET /async/data Gets data

Implementation Notes
Gets data asynchronously

Response Class (Status 200)
ModelModel Schema
{}

Response Content Type 

Response Messages
HTTP Status Code    Reason  Response Model  Headers
401 Unauthorized        
403 Forbidden       
404 Not Found

共有2个答案

谭曦
2023-03-14

除了使用

new Docket().useDefaultResponseMessages(false)

根据要返回的状态代码,您可能还需要使用此注释:

@ResponseStatus(HttpStatus.CREATED)

⚠️ 不要在WebFlux中使用ResponseEntity,因为这将始终添加200个代码。查看此github问题。

夏侯博
2023-03-14

您应该能够设置插件不使用默认的响应消息。请遵循以下不同版本的说明。

对于1.0.2或之前

  new SwaggerSpringMvcPlugin(...)
        //More config
        .useDefaultResponseMessages(false) //<-- this should be false
  ...;

对于2. x

  new Docket()
        //More config
        .useDefaultResponseMessages(false) //<-- this should be false
  ...;
 类似资料:
  • 我正在使用Swagger注释和SpringFox为我的REST API(使用Sprint Boot构建)生成Swagger规范。我正在用将返回的代码注释每个方法。例如: 然而,有些东西(我假设SpringFox)正在向每个API调用添加一个200响应代码,而不管它是否已定义。我知道我可以通过在每个方法中添加注释来删除此项,但a)这似乎是@ApiResponse定义的不必要重复,b)某些方法可能返回

  • 我的pom.xml 招摇过市配置 服务器日志 它说映射: 但这些都不起作用(404): 如果我使用sping-fox较低版本,那么我将在我的日志中得到它已映射{[/v2/api-docs}],方法=[GET]。但是,我看不到在那里生成的任何json。

  • 当我打开它时,所有操作都显示为折叠,并且我希望它在默认情况下展开。 有什么我需要改变的属性来实现它吗? 这是我的霸气豆:

  • 我对使用SpringBoot和Springfox-boot-starter的swagger文档有一个问题。 我使用java.time.Instant java.util.Optio包裹 有没有办法让这个工作与可选的?感谢任何建议! Spring启动版本: Springfox-boot-starter版本

  • Node的console.log在默认情况下似乎会截断输出,例如,查看API的输出: 如您所见,没有展开。我想这是一个方便的措施--很多人不希望node在默认情况下喷出数千行。有没有一种方法我可以告诉它扩展日志项的内容?

  • 问题内容: 该函数将与关联的终结器设置为。 默认情况下会终结哪种对象? 默认情况下终结那些对象会导致哪些意外陷阱? 问题答案: 默认情况下,完成以下对象: os。File:当对象被垃圾回收时,文件自动关闭。 os。流程:完成将释放与流程相关的任何资源。在Unix上,这是空操作。在Windows上,它关闭与进程关联的句柄。 在Windows上,程序包似乎可以自动关闭网络连接。 除了上述对象之外,Go