$show=/label

How To Set Base Path or Context Path In Spring Boot?

SHARE:

A quick guide to change the context path in Spring Boot? And also How to set the base path for a new Spring Boot application.

1. Introduction


In this tutorial, We'll be learning how to set a base path in a new spring boot application? And also how the existing context path can be changed to new values in different ways.

2. Setting Property in application.properties


Older and new versions of spring boot support in doing our own base path using configurations file that is application.properties.

Spring Boot 1.x:

spring.data.rest.basePath=/api/v1

Spring Boot 2.x:

server.servlet.context-path=/api/v1

The main difference is path is called a base path in 1.x and context path in 2.x but the meaning of both is the same.

Both of these change to proceeding with "/api/v1".


3. Using Java Property Using System


You can use the System.setProperty() method to set the base path.

public static void main(String[] args) {
    System.setProperty("server.servlet.context-path", "/api/v1");
    SpringApplication.run(Application.class, args);
}

4. Using OS Variables


Mac OS X: Open the terminal and run the command.

$ export SERVER_SERVLET_CONTEXT_PATH=/api/v1

Windows: Run the below command in command prompt.

set SERVER_SERVLET_CONTEXT_PATH=/api/v1

5. Java Command Line Argument


You can set the base path when starting up the spring boot application as below.

$ java -jar app.jar --server.servlet.context-path=/api/v1

6. Using RepositoryRestConfigurer


This works spring boot 1.1 before versions and even if you are not using Spring Boot.

@Configuration
class CustomRestMvcConfiguration {

  @Bean
  public RepositoryRestConfigurer repositoryRestConfigurer() {

    return new RepositoryRestConfigurerAdapter() {

      @Override
      public void configureRepositoryRestConfiguration(RepositoryRestConfiguration config) {
        config.setBasePath("/api/v1");
      }
    };
  }
}


7. Spring Boot 2.x WebServerFactoryCustomizer


@Bean
 public WebServerFactoryCustomizer webServerFactoryCustomizer() {
  WebServerFactoryCustomizer customizer = factory -> factory
    .setContextPath("/api/v1");

  logger.info("Setting up the custom base path ");
  return customizer;
 }

8. Conclusion


In this article, We have seen how to set the context path in spring boot applications.

Below are the priority list from high to low. Always Java config will be in higher precedence.

Java Config - Is the highest priority
Command Line Args - 2nd
Java System Properties - 3rd
OS Level Environment Variables - 4th
application.properties in Current Directory - 5th
application.properties in the classpath  (src/main/resources or the packaged jar file) - Least priority

GitHub Java Config

GitHub properties file

COMMENTS

BLOGGER

About Us

Author: Venkatesh - I love to learn and share the technical stuff.
Name

accumulo,1,ActiveMQ,2,Adsense,1,API,37,ArrayList,16,Arrays,16,Bean Creation,3,Bean Scopes,1,BiConsumer,1,Blogger Tips,1,Books,1,C Programming,1,Collection,5,Collections,23,Collector,1,Command Line,1,Compile Errors,1,Configurations,7,Constants,1,Control Statements,8,Conversions,6,Core Java,84,Corona India,1,Create,2,CSS,1,Date,3,Date Time API,12,Dictionary,1,Difference,1,Download,1,Eclipse,2,Efficiently,1,Error,1,Errors,1,Exception,1,Exceptions,3,Fast,1,Files,10,Float,1,Font,1,Form,1,Freshers,1,Function,3,Functional Interface,2,Garbage Collector,1,Generics,4,Git,4,Grant,1,Grep,1,HashMap,1,HomeBrew,2,HTML,2,HttpClient,2,Immutable,1,Installation,1,Interview Questions,5,Iterate,2,Jackson API,3,Java,30,Java 10,1,Java 11,5,Java 12,5,Java 13,2,Java 14,2,Java 8,77,Java 8 Difference,2,Java 8 Stream Conversions,2,java 8 Stream Examples,3,Java 9,1,Java Conversions,11,Java Design Patterns,1,Java Files,1,Java Program,3,Java Programs,93,java.lang,5,java.util. function,1,jQuery,1,Kotlin,10,Kotlin Conversions,3,Kotlin Programs,6,Lambda,1,lang,29,Leap Year,1,live updates,1,Logging,1,Mac OS,2,Math,1,Matrix,5,Maven,1,Method References,1,Mockito,1,MongoDB,3,New Features,1,Operations,1,Optional,6,Oracle,5,Oracle 18C,1,Partition,1,Patterns,1,Programs,1,Property,1,Python,2,Quarkus,1,Read,1,Real Time,1,Recursion,2,Remove,2,Rest API,1,Schedules,1,Serialization,1,Servlet,2,Sort,1,Sorting Techniques,8,Spring,2,Spring Boot,23,Spring Email,1,Spring MVC,1,Streams,23,String,58,String Programs,12,String Revese,1,Swing,1,System,1,Tags,1,Threads,10,Tomcat,1,Tomcat 8,1,Troubleshoot,16,Unix,2,Updates,3,util,5,While Loop,1,
ltr
item
JavaProgramTo.com: How To Set Base Path or Context Path In Spring Boot?
How To Set Base Path or Context Path In Spring Boot?
A quick guide to change the context path in Spring Boot? And also How to set the base path for a new Spring Boot application.
JavaProgramTo.com
https://www.javaprogramto.com/2020/04/how-to-set-base-path-or-context-path-in-spring-boot.html
https://www.javaprogramto.com/
https://www.javaprogramto.com/
https://www.javaprogramto.com/2020/04/how-to-set-base-path-or-context-path-in-spring-boot.html
true
3124782013468838591
UTF-8
Loaded All Posts Not found any posts VIEW ALL Readmore Reply Cancel reply Delete By Home PAGES POSTS View All RECOMMENDED FOR YOU LABEL ARCHIVE SEARCH ALL POSTS Not found any post match with your request Back Home Sunday Monday Tuesday Wednesday Thursday Friday Saturday Sun Mon Tue Wed Thu Fri Sat January February March April May June July August September October November December Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec just now 1 minute ago $$1$$ minutes ago 1 hour ago $$1$$ hours ago Yesterday $$1$$ days ago $$1$$ weeks ago more than 5 weeks ago Followers Follow THIS PREMIUM CONTENT IS LOCKED STEP 1: Share to a social network STEP 2: Click the link on your social network Copy All Code Select All Code All codes were copied to your clipboard Can not copy the codes / texts, please press [CTRL]+[C] (or CMD+C with Mac) to copy Table of Content