为HttpServletRequest使用Swager文档

Question

我是新来的swagger和使用它的留档。我目前正在尝试使用swagger来显示PATCH请求的请求体。以前，PATCH方法的参数是正在更新的对象的DTO，这使得显示对象的属性变得非常容易（因为我正在使用SpringBoot，并使用@架构完美地工作）。然而，现在PATCH方法的参数是一个HttpServlet请求。我不想在swagger doc中显示HttpServlet请求（这似乎是自动发生的），而是想显示DTO的属性（就像以前做的那样）。我想知道是否有办法做到这一点？

任何建议都非常感谢！

Answer 1

如何在swagger文档中显示HttpServletRequest？

您可以在配置中设置swagger2，SwaggerConfig.java

new Docket(DocumentationType.SWAGGER_2)
                ...
                .ignoredParameterTypes(HttpSession.class, HttpServletRequest.class, HttpServletResponse.class)
                .build();

Answer 2

上面的答案不起作用，因为向方法添加另一个参数会破坏方法本身的功能。

有效的解决方案是在控制器中将内容参数添加到@审视体注释中：

@RequestBody(description = "Description.", 
           content = @Content(schema = @Schema(implementation = ObjectDTO.class)));

Answer 3

我假设你正在使用springdoc-openapi来生成SwaggerUI。

要使用它，您可以使用以下 Maven 依赖项，

<dependency>
  <groupId>org.springdoc</groupId>
  <artifactId>springdoc-openapi-ui</artifactId>
  <version>1.4.2</version>
</dependency>
<dependency>
  <groupId>org.springdoc</groupId>
  <artifactId>springdoc-openapi-webmvc-core</artifactId>
  <version>1.4.2</version>
</dependency>

从springdoc-openapi的v1.1.25开始，HttpServletRequest和HttpServletResponse将被添加到被忽略类型的列表中。

见下文，

https://github.com/springdoc/springdoc-openapi/issues/57

因此，即使我们将 HttpServletRequest 作为参数添加到控制器方法中，它也将被忽略，并且不会显示在 swagger 中。

所以回到你的问题，为了显示类的模型，你可以描述另一个参数和HttpServletRequest，如下所示，

@Operation(summary = "Returns a token", description = "Returns A token API", tags = "tokenGeneration", responses = {

            @ApiResponse(description = "Successful Operation", responseCode = "200", content = @Content(mediaType = "application/json", schema = @Schema(implementation = Timeresponse.class))),
            @ApiResponse(description = "not found Operation", responseCode = "404") })
    @PatchMapping("/getTokenPatchRequest")
    public ResponseEntity getTokenpatch(HttpServletRequest request, @RequestBody AuthReq2 req) {

        log.info("The HttpServlet request header contains the information : " + request.getHeader("Authorization"));

Auth2的模型类如下，它可以描述您的用户名和密码等示例值。

import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;

@Data
public class AuthReq2 {
    
    @Schema(example = "diannamcallister")
    private String userName;
    
    @Schema(example = "test")
    private String password;

}

最后大摇大摆的页面看起来像这样，

当您在授权标头中输入内容时，如下所示，

这可以通过下面的代码通过HTTP servlet请求访问，

log.info("The HttpServlet request header contains the information : " + request.getHeader("Authorization"));

springboot应用程序中的日志条目如下所示，

10:40:01.876 INFO   OpenApiController.getTokenpatch:163 - The HttpServlet request header contains the information : stackoverflow