春のブーツで残りのベースURLを設定するにはどうすればよいですか？

私は単一の春のブートプロジェクトでmvcと休憩を混合しようとしています。

すべての残りのコントローラー（例：example.com/api）のベースパスを1か所に設定したい（@RequestMapping('api/products')代わりに、で各コントローラーに注釈を付けたくありません）@RequestMapping('/products')。

MVCコントローラーは、example.com / whateverからアクセスできる必要があります

出来ますか？

（私はSpring Data Restを使用せず、Spring MVCのみを使用しています）

Spring Boot 1.2+（2.0未満）では、application.propertiesの単一のプロパティのみが必要です。

spring.data.rest.basePath=/api

参照リンク：https : //docs.spring.io/spring-data/rest/docs/current/reference/html/#getting-started.changing-base-uri

2.xの場合は、

server.servlet.context-path=/api

少し遅れましたが、同じ質問が答えに到達する前にここに来たので、ここに投稿します。（まだ持っていない場合は）application.propertiesを作成して追加します。

server.contextPath=/api

したがって、前の例でRestControllerを使用している場合は、次の@RequestMapping("/test")ようにアクセスします。localhost:8080/api/test/{your_rest_method}

質問の出典：スプリングブートWebアプリのURLを選択するには

春のブートフレームワークのバージョン2.0.4.RELEASE+。この行を追加application.properties

server.servlet.context-path=/api

これは問題に対する最初のgoogleヒットであり、より多くの人々がこれを検索することになると思います。Spring Boot '1.4.0'以降、新しいオプションがあります。アノテーションが付けられたクラスに異なるパスを定義できるカスタムRequestMappingHandlerMappingを定義できるようになりましたました

@RestControllerと@RequestMappingを組み合わせたカスタムアノテーション付きの別のバージョンは、このブログ投稿にあります。

@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);
                    }
                };
            }
        };
    }
}

この一見単純な質問の答えがどれほど複雑かは信じられませんでした。ここにいくつかの参照があります：

• 春ジラチケット
• 別のSOの質問
• さらに別のSOの質問
• 問題を示す非常に素晴らしいGitRepository

考慮すべき点は数多くあります。

1. を設定server.context-path=/apiするapplication.propertiesことで、すべてのプレフィックスを構成できます（server.contextPathではなく、server.context-path！）
2. 残りのエンドポイントとしてリポジトリを公開@RepositoryRestControllerでアノテート春データコントローラは、環境変数を使用しますspring.data.rest.base-pathでapplication.properties。しかし、プレーン@RestControllerはこれを考慮に入れません。春のデータの残りのドキュメントによると、@BasePathAwareControllerそのために使用できる注釈があります。しかし、このようなコントローラーを保護しようとすると、Springのセキュリティに関して問題があります。もう見つかりません。

別の回避策は単純なトリックです。アノテーションで静的な文字列をプレフィックスすることはできませんが、次のような式を使用できます。

@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\"}";
  }
}

Boot 2.0.0+の場合、これは私にとってはうまくいきます：server.servlet.context-path = / api

残りのコントローラーのみに影響するクリーンなソリューションを見つけました。

@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);
    }
}

春ブーツは2つのディスパッチャサーブレットを登録します-デフォルトdispatcherServletのコントローラのための、およびrestApiディスパッチャのため@RestControllersに定義されています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 [/]

例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>

ただし、これに限定されません。

• use XmlWebApplicationContext、使用可能な他のコンテキストタイプを使用できます。AnnotationConfigWebApplicationContext、GenericWebApplicationContext、GroovyWebApplicationContext、...
• define jsonMessageConverter、messageConvertersbeanは残りのコンテキストで、親コンテキストで定義できます

コントローラのカスタムアノテーションを作成できます。

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

コントローラークラスで通常の@RestControllerの代わりに使用し、@ RequestMappingでメソッドに注釈を付けます。

テスト済み-Spring 4.2で動作します！

少し遅れるかもしれませんが、それが最善の解決策だと思います。application.yml（または類似の設定ファイル）で設定します：

spring:
    data:
        rest:
            basePath: /api

私はそれを覚えているので、あなたのすべてのリポジトリはこのURIの下に公開されます。

PathMatchConfigurer（Spring Boot 2.x）を使用してみてください：

@Configuration
public class WebMvcConfig implements WebMvcConfigurer  {

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

@RequestMapping("rest")アノテーション付きの基本クラスを作成し、この基本クラスを使用して他のすべてのクラスを拡張できます。

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

これで、この基本クラスを拡張するすべてのクラスにでアクセスできるようになりますrest/**。

YAML設定（application.yaml）を使用する人向け。

注：これは、Spring Boot 2.x.x

server:
  servlet:
    contextPath: /api

まだ使用している場合 Spring Boot 1.x

server:
  contextPath: /api

spring-boot 2.xでは、application.propertiesで構成できます。

spring.mvc.servlet.path=/api

server.servlet.context-path=/api私が推測する解決策でしょう。私は同じ問題を抱えていましたが、これで解決しました。server.context-pathを使用しました。しかし、それは非推奨であるように思われ、私server.servlet.context-pathはこれで問題を解決することがわかりました。別の回避策として、フロントエンド（H5）ページにベースタグを追加しました。これが誰かの役に立てば幸いです。

乾杯

このソリューションは、次の場合に適用されます。

1. 接頭辞は付けたいRestControllerが、付けたくないController。

2. Spring Data Restを使用していません。

   @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);
       }
   }

   }

これはmh-devによって投稿されたソリューションに似ていますが、これは少しすっきりしていて、2.0.0 +を含むすべてのバージョンのSpring Boot 1.4.0+でサポートされるはずです。

Spring Data REST ドキュメントごとに、application.propertiesを使用している場合は、このプロパティを使用してベースパスを設定します。

spring.data.rest.basePath=/api

ただし、Spring は リラックスしたバインディングを使用するため、このバリエーションを使用できます。

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

...または必要に応じてこれ：

spring.data.rest.base_path=/api

使用している場合application.ymlを、あなたはキー区切りのためのコロンを使用します。

spring:
  data:
    rest:
      basePath: /api

（参考までに、ドキュメントを明確にするために、関連するチケットが2018年3月に作成されました。）

機能したserver.contextPath = / path

コントローラのカスタムアノテーションを作成できます。

コントローラークラスで通常の@RestControllerの代わりに使用し、@ RequestMappingでメソッドに注釈を付けます。

Spring 4.2では問題なく動作します。