How to Hide HttpServletRequest in Swagger OpenAPI 3

Описание: Learn how to easily hide the `HttpServletRequest` parameter in Swagger OpenAPI 3 with a simple annotation in your Spring Boot application.
---
This video is based on the question https://stackoverflow.com/q/75507436/ asked by the user 'Ho Quang Lam' ( https://stackoverflow.com/u/14074180/ ) and on the answer https://stackoverflow.com/a/75507533/ provided by the user 'bezbos.' ( https://stackoverflow.com/u/8524584/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: Hide HttpServletRequest request in Swagger OpenAPI 3

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
Hiding HttpServletRequest in Swagger OpenAPI 3

If you are working with Spring Boot and utilizing Swagger OpenAPI 3, you may have encountered an issue where HttpServletRequest is shown as a required parameter in the Swagger UI. This can be particularly frustrating since you don't want this internal request parameter to clutter your API documentation. In this guide, we'll discuss how to solve this problem effectively.

Understanding the Problem

When you define your REST endpoints in a Spring Boot application, the HttpServletRequest object is sometimes included as a method parameter. By default, Swagger UI treats this as a required request parameter, which is not ideal for a clean and concise API documentation.

Example of the Issue

Consider the following method defined in your controller:

[[See Video to Reveal this Text or Code Snippet]]

In this case, Swagger UI displays both paramOne and request as required parameters. The inclusion of request as a visible parameter can lead to confusion for anyone using your API documentation.

The Solution

To hide the HttpServletRequest parameter from appearing in the Swagger UI, you can use the -Parameter annotation with the attribute hidden = true. This is a straightforward fix that doesn't require altering much of your existing codebase.

Step-by-Step Fix

Locate your controller method where you have the HttpServletRequest parameter.

Modify the declaration of your method to include the -Parameter annotation.

Here’s how your updated controller method should look:

[[See Video to Reveal this Text or Code Snippet]]

Explanation of Changes

By adding -Parameter(hidden = true) next to HttpServletRequest request, you instruct Swagger to ignore this parameter when generating the API documentation.

After this modification, request will no longer appear as a required parameter in the Swagger UI, allowing your API documentation to be cleaner and more user-friendly.

Conclusion

Hiding the HttpServletRequest parameter in Swagger OpenAPI 3 is a simple and effective way to enhance the usability of your API documentation. By using the -Parameter(hidden = true) annotation, you can provide a more streamlined interface for your users without unnecessary clutter.

If you face any further issues with Swagger UI or need additional customization within your Spring Boot application, feel free to explore the official Springdoc documentation for more tips and enhancements.

Happy coding!