Wie setze ich die Basis-URL für die Ruhe im Frühlingsstiefel?

Ich versuche, mvc zu mischen und mich in einem einzigen Spring-Boot-Projekt auszuruhen.

Ich möchte den Basispfad für alle Rest-Controller (z. B. example.com/api) an einem einzigen Ort festlegen (ich möchte nicht jeden Controller mit Anmerkungen versehen @RequestMapping('api/products') stattdessen nur@RequestMapping('/products') .

Mvc-Controller sollten über example.com/whatever zugänglich sein

Ist es möglich?

(Ich benutze keine Federdatenruhe, nur Feder-MVC)

Mit Spring Boot 1.2+ (<2.0) ist lediglich eine einzige Eigenschaft in application.properties erforderlich:

spring.data.rest.basePath=/api

Referenzlink: https://docs.spring.io/spring-data/rest/docs/current/reference/html/#getting-started.changing-base-uri

Verwenden Sie für 2.x.

server.servlet.context-path=/api

Ein bisschen spät, aber die gleiche Frage brachte mich hierher, bevor ich die Antwort erreichte, also poste ich sie hier. Erstellen Sie (falls Sie es noch nicht haben) eine application.properties und fügen Sie sie hinzu

server.contextPath=/api

Wenn Sie also im vorherigen Beispiel einen RestController dabei @RequestMapping("/test")haben, greifen Sie wie folgt darauf zulocalhost:8080/api/test/{your_rest_method}

Frage Quelle: Wie wähle ich die URL für meine Spring Boot Webapp

Für Spring Boot Framework Version 2.0.4.RELEASE+. Fügen Sie diese Zeile hinzuapplication.properties

server.servlet.context-path=/api

Da dies der erste Google-Treffer für das Problem ist und ich davon ausgehe, dass mehr Leute danach suchen werden. Seit Spring Boot '1.4.0' gibt es eine neue Option. Es ist jetzt möglich, ein benutzerdefiniertes RequestMappingHandlerMapping zu definieren, mit dem ein anderer Pfad für mit @RestController kommentierte Klassen definiert werden kann

Eine andere Version mit benutzerdefinierten Anmerkungen, die @RestController mit @RequestMapping kombiniert , finden Sie in diesem Blogbeitrag

@Configuration
public class WebConfig {

    @Bean
    public WebMvcRegistrationsAdapter webMvcRegistrationsHandlerMapping() {
        return new WebMvcRegistrationsAdapter() {
            @Override
            public RequestMappingHandlerMapping getRequestMappingHandlerMapping() {
                return new RequestMappingHandlerMapping() {
                    private final static String API_BASE_PATH = "api";

                    @Override
                    protected void registerHandlerMethod(Object handler, Method method, RequestMappingInfo mapping) {
                        Class<?> beanType = method.getDeclaringClass();
                        if (AnnotationUtils.findAnnotation(beanType, RestController.class) != null) {
                            PatternsRequestCondition apiPattern = new PatternsRequestCondition(API_BASE_PATH)
                                    .combine(mapping.getPatternsCondition());

                            mapping = new RequestMappingInfo(mapping.getName(), apiPattern,
                                    mapping.getMethodsCondition(), mapping.getParamsCondition(),
                                    mapping.getHeadersCondition(), mapping.getConsumesCondition(),
                                    mapping.getProducesCondition(), mapping.getCustomCondition());
                        }

                        super.registerHandlerMethod(handler, method, mapping);
                    }
                };
            }
        };
    }
}

Ich konnte nicht glauben, wie kompliziert die Antwort auf diese scheinbar einfache Frage ist. Hier einige Referenzen:

• Spring JIRA Ticket
• Eine weitere SO-Frage
• Noch eine SO-Frage
• Sehr schönes GitRepository, das das Problem aufzeigt

Es gibt viele verschiedene Dinge zu beachten:

1. Durch die Einstellung server.context-path=/apiin application.propertiesSie können ein Präfix für konfigurieren alles . (Sein server.context-Pfad nicht server.contextPath!)
2. Mit @RepositoryRestController kommentierte Spring Data Controller, die ein Repository als Restendpunkt verfügbar machen, verwenden die Umgebungsvariable spring.data.rest.base-pathin application.properties. Aber einfach @RestControllerwird dies nicht berücksichtigt. Laut der Dokumentation der Federdatenreste gibt es eine Anmerkung @BasePathAwareController, die Sie dafür verwenden können. Ich habe jedoch Probleme mit der Spring-Sicherheit, wenn ich versuche, einen solchen Controller zu sichern. Es wird nicht mehr gefunden.

Eine weitere Problemumgehung ist ein einfacher Trick. Sie können einer Annotation keinen statischen String voranstellen, aber Sie können Ausdrücke wie diesen verwenden:

@RestController
public class PingController {

  /**
   * Simple is alive test
   * @return <pre>{"Hello":"World"}</pre>
   */
  @RequestMapping("${spring.data.rest.base-path}/_ping")
  public String isAlive() {
    return "{\"Hello\":\"World\"}";
  }
}

Für Boot 2.0.0+ funktioniert dies für mich: server.servlet.context-path = / api

Ich habe eine saubere Lösung gefunden, die nur Rest-Controller betrifft.

@SpringBootApplication
public class WebApp extends SpringBootServletInitializer {

    @Autowired
    private ApplicationContext context;

    @Bean
    public ServletRegistrationBean restApi() {
        XmlWebApplicationContext applicationContext = new XmlWebApplicationContext();
        applicationContext.setParent(context);
        applicationContext.setConfigLocation("classpath:/META-INF/rest.xml");

        DispatcherServlet dispatcherServlet = new DispatcherServlet();
        dispatcherServlet.setApplicationContext(applicationContext);

        ServletRegistrationBean servletRegistrationBean = new ServletRegistrationBean(dispatcherServlet, "/rest/*");
        servletRegistrationBean.setName("restApi");

        return servletRegistrationBean;
    }

    static public void main(String[] args) throws Exception {
        SpringApplication.run(WebApp.class,args);
    }
}

Spring Boot registriert zwei Dispatcher-Servlets - Standard dispatcherServletfür Controller und restApiDispatcher für @RestControllersdefiniert in rest.xml:

2016-06-07 09:06:16.205  INFO 17270 --- [           main] o.s.b.c.e.ServletRegistrationBean        : Mapping servlet: 'restApi' to [/rest/*]
2016-06-07 09:06:16.206  INFO 17270 --- [           main] o.s.b.c.e.ServletRegistrationBean        : Mapping servlet: 'dispatcherServlet' to [/]

Das Beispiel rest.xml:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="
  http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
  http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd
  http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd">

    <context:component-scan base-package="org.example.web.rest"/>
    <mvc:annotation-driven/>

    <!-- Configure to plugin JSON as request and response in method handler -->
    <bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter">
        <property name="messageConverters">
            <list>
                <ref bean="jsonMessageConverter"/>
            </list>
        </property>
    </bean>

    <!-- Configure bean to convert JSON to POJO and vice versa -->
    <bean id="jsonMessageConverter" class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
    </bean>
</beans>

Sie sind jedoch nicht beschränkt auf :

• Verwenden XmlWebApplicationContextSie, können Sie einen anderen verfügbaren Kontexttyp verwenden, z. AnnotationConfigWebApplicationContext, GenericWebApplicationContext, GroovyWebApplicationContext, ...
• definieren jsonMessageConverter, messageConvertersBeans im Ruhekontext, sie können im übergeordneten Kontext definiert werden

Sie können eine benutzerdefinierte Anmerkung für Ihre Controller erstellen:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@RestController
@RequestMapping("/test")
public @interface MyRestController {
}

Verwenden Sie es anstelle des üblichen @RestControllers für Ihre Controller-Klassen und kommentieren Sie Methoden mit @RequestMapping.

Gerade getestet - funktioniert im Frühjahr 4.2!

Ich könnte etwas spät dran sein, ABER ... Ich glaube, es ist die beste Lösung. Richten Sie es in Ihrer application.yml (oder einer analogen Konfigurationsdatei) ein:

spring:
    data:
        rest:
            basePath: /api

Soweit ich mich erinnern kann, werden alle Ihre Repositorys unter dieser URI angezeigt.

Versuchen Sie es mit einem PathMatchConfigurer (Spring Boot 2.x):

@Configuration
public class WebMvcConfig implements WebMvcConfigurer  {

    @Override
    public void configurePathMatch(PathMatchConfigurer configurer) {
        configurer.addPathPrefix("api", HandlerTypePredicate.forAnnotation(RestController.class));
    }
}

Sie können eine Basisklasse mit @RequestMapping("rest")Anmerkungen erstellen und alle anderen Klassen mit dieser Basisklasse erweitern.

@RequestMapping("rest")
public abstract class BaseController {}

Jetzt sind alle Klassen zugänglich, die diese Basisklasse erweitern rest/**.

Für diejenigen, die die YAML-Konfiguration verwenden (application.yaml).

Hinweis : Dies funktioniert nur fürSpring Boot 2.x.x

server:
  servlet:
    contextPath: /api

Wenn Sie noch verwenden Spring Boot 1.x

server:
  contextPath: /api

Mit Spring-Boot 2.x können Sie in application.properties Folgendes konfigurieren:

spring.mvc.servlet.path=/api

server.servlet.context-path=/apiwäre die Lösung, denke ich. Ich hatte das gleiche Problem und das hat mich gelöst. Ich habe server.context-path verwendet. Das schien jedoch veraltet zu sein und ich fand, dass server.servlet.context-pathdas Problem jetzt gelöst ist. Eine weitere Problemumgehung war das Hinzufügen eines Basis-Tags zu meinen Front-End-Seiten (H5). Ich hoffe das hilft jemandem da draußen.

Prost

Diese Lösung gilt, wenn:

1. Sie möchten ein Präfix setzen, RestControlleraber nicht Controller.

2. Sie verwenden Spring Data Rest nicht.

   @Configuration
   public class WebConfig extends WebMvcConfigurationSupport {
   
   @Override
   protected RequestMappingHandlerMapping createRequestMappingHandlerMapping() {
       return new ApiAwareRequestMappingHandlerMapping();
   }
   
   private static class ApiAwareRequestMappingHandlerMapping extends RequestMappingHandlerMapping {
   
       private static final String API_PATH_PREFIX = "api";
   
       @Override
       protected void registerHandlerMethod(Object handler, Method method, RequestMappingInfo mapping) {
           Class<?> beanType = method.getDeclaringClass();
           if (AnnotationUtils.findAnnotation(beanType, RestController.class) != null) {
               PatternsRequestCondition apiPattern = new PatternsRequestCondition(API_PATH_PREFIX)
                       .combine(mapping.getPatternsCondition());
   
               mapping = new RequestMappingInfo(mapping.getName(), apiPattern, mapping.getMethodsCondition(),
                       mapping.getParamsCondition(), mapping.getHeadersCondition(), mapping.getConsumesCondition(),
                       mapping.getProducesCondition(), mapping.getCustomCondition());
           }
           super.registerHandlerMethod(handler, method, mapping);
       }
   }

   }}

Dies ähnelt der von mh-dev veröffentlichten Lösung , aber ich denke, dies ist ein wenig sauberer und sollte auf jeder Version von Spring Boot 1.4.0+, einschließlich 2.0.0+, unterstützt werden.

Verwenden Sie in Spring Data REST- Dokumenten , wenn Sie application.properties verwenden, diese Eigenschaft, um Ihren Basispfad festzulegen:

spring.data.rest.basePath=/api

Beachten Sie jedoch, dass Spring eine entspannte Bindung verwendet , sodass diese Variante verwendet werden kann:

spring.data.rest.base-path=/api

... oder dieses, wenn Sie es vorziehen:

spring.data.rest.base_path=/api

Wenn Sie application.yml verwenden , würden Sie Doppelpunkte für Schlüsseltrennzeichen verwenden:

spring:
  data:
    rest:
      basePath: /api

(Als Referenz wurde im März 2018 ein entsprechendes Ticket erstellt, um die Dokumente zu verdeutlichen.)

arbeitete server.contextPath = / path

Sie können eine benutzerdefinierte Anmerkung für Ihre Controller erstellen:

Verwenden Sie es anstelle des üblichen @RestControllers für Ihre Controller-Klassen und kommentieren Sie Methoden mit @RequestMapping.

Funktioniert gut im Frühjahr 4.2!