SpringBoot中AuthApi接口未配置ObjectMapper/HttpServletRequest问题求助

问题背景 #

使用Open API Maven插件生成接口和Payload搭建auth-service项目后，调用/auth/signup接口时出现警告：ObjectMapper or HttpServletRequest not configured in default AuthApi interface，接口无法正常工作。

可能问题及对应解决方案 #

1. 生成的AuthApi接口依赖未被注入 #

警告直接指向ObjectMapper或HttpServletRequest未配置，说明生成的接口默认实现需要这两个依赖，但未通过Spring注入。

• 解决方案：
  在自定义控制器中手动注入这两个依赖，确保Spring容器管理实例：

  @RestController
  public class AuthController implements AuthApi {
      private final ObjectMapper objectMapper;
      private final HttpServletRequest request;
  
      // 通过构造方法注入（推荐Spring 4.3+无@Autowired写法）
      public AuthController(ObjectMapper objectMapper, HttpServletRequest request) {
          this.objectMapper = objectMapper;
          this.request = request;
      }
  
      // 实现signup接口方法
      @Override
      public ResponseEntity<Void> signup(SignupRequest signupRequest) {
          // 业务逻辑实现
          return ResponseEntity.ok().build();
      }
  }
  

2. Open API插件生成代码不符合Spring规范 #

插件默认生成的代码可能缺少Spring依赖注入注解，导致无法自动装配依赖。

• 解决方案：
  修改pom.xml中的插件配置，添加Spring相关参数，确保生成的代码支持自动注入：

  <plugin>
      <groupId>org.openapitools</groupId>
      <artifactId>openapi-generator-maven-plugin</artifactId>
      <version>6.6.0</version> <!-- 使用最新稳定版 -->
      <executions>
          <execution>
              <goals>
                  <goal>generate</goal>
              </goals>
              <configuration>
                  <inputSpec>${project.basedir}/src/main/resources/swagger.yaml</inputSpec>
                  <generatorName>spring</generatorName>
                  <configOptions>
                      <delegatePattern>true</delegatePattern>
                      <useSpringBoot3>true</useSpringBoot3>
                      <interfaceOnly>true</interfaceOnly>
                      <useAutowiredForRequiredParams>true</useAutowiredForRequiredParams>
                  </configOptions>
              </configuration>
          </execution>
      </executions>
  </plugin>
  

  重新执行mvn clean generate-sources生成符合要求的接口代码。

3. Security配置拦截了/signup请求 #

如果Spring Security配置未放行/auth/signup接口，请求会被拦截导致无法到达控制器。

• 解决方案：
  在Security配置类中添加放行规则：

  @Configuration
  @EnableWebSecurity
  public class SecurityConfig {
      @Bean
      public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
          http
              .csrf(csrf -> csrf.disable()) // 注册接口可临时关闭CSRF
              .authorizeHttpRequests(auth -> auth
                  .requestMatchers("/auth/signup").permitAll()
                  .anyRequest().authenticated()
              );
          return http.build();
      }
  }
  

4. 项目依赖缺失 #

缺少Spring Web或Jackson相关依赖会导致ObjectMapper无法自动配置。

• 解决方案：
  检查pom.xml中是否包含以下核心依赖：

  <dependencies>
      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-web</artifactId>
      </dependency>
      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-security</artifactId>
      </dependency>
      <dependency>
          <groupId>com.fasterxml.jackson.core</groupId>
          <artifactId>jackson-databind</artifactId>
      </dependency>
  </dependencies>
  

5. 接口路径不匹配 #

生成的AuthApi接口上的@RequestMapping路径可能与实际请求路径不一致。

• 解决方案：
  检查生成的AuthApi接口注解，确保路径正确：

  @RequestMapping(value = "/auth", produces = {"application/json"})
  public interface AuthApi {
      @PostMapping(value = "/signup", consumes = {"application/json"})
      ResponseEntity<Void> signup(@RequestBody SignupRequest signupRequest);
  }
  

  确认自定义控制器未覆盖错误的路径注解。

内容的提问来源于stack exchange，提问作者Pradnya Kulkarni