Annotation Interface EnableProxyApiController


@Configuration @Documented @Retention(RUNTIME) @Target(TYPE) @Import({ProxyApiFindConfig.class,ApiFindRegistrar.class}) public @interface EnableProxyApiController
Enables the proxy-api-controller framework in a Spring Boot application.

Add this annotation to any @Configuration class (typically the application's main class) to activate the dynamic REST controller infrastructure. It imports ProxyApiFindConfig (component scan + utilities) and ApiFindRegistrar (bean registration for interfaces annotated with ApiFindController).

Usage


 @SpringBootApplication
 @EnableProxyApiController(basePackages = "com.example.controller")
 public class MyApplication {
     public static void main(String[] args) {
         SpringApplication.run(MyApplication.class, args);
     }
 }
 
Author:
Francesco Baldi
See Also:
  • Element Details

    • value

      String[] value
      Alias for basePackages().
      Returns:
      base packages to scan for @ApiFindController interfaces
      Default:
      {}
    • basePackages

      String[] basePackages
      Base packages to scan for interfaces annotated with ApiFindController.
      Returns:
      the packages to scan; defaults to the package of the annotated class
      Default:
      {}
    • basePackageClasses

      Class<?>[] basePackageClasses
      Type-safe alternative to basePackages(): the package of each specified class is used as a scan root.
      Returns:
      marker classes whose packages should be scanned
      Default:
      {}
    • defaultConfiguration

      Class<?>[] defaultConfiguration
      Additional configuration classes to import into the application context.
      Returns:
      extra configuration classes; empty by default
      Default:
      {}
    • clients

      Class<?>[] clients
      Specific controller interface classes to register directly, bypassing the classpath scan.
      Returns:
      controller interface classes to register; empty by default
      Default:
      {}