Practice Now
Java
Spring Boot
index.html
root mapping
web development

Java Spring Boot How to map my app root “/” to index.html?

Interview Questions practice on Codemia

Over 8,000 real interview questions from top companies, searchable by company and role.

Browse interview questions
JavaJavaScript & Web

Introduction

Java Spring Boot is a powerful, rapid-development framework used for creating standalone, production-grade Spring-based applications. It simplifies the development process by auto-configuring many components required in a typical Spring application. One of the common tasks in web application development is to map the root context ("/") of your application to a index.html file. This can be useful for setting a default page or UI landing page for your application.

In this article, we'll explore how to perform this mapping in a Spring Boot application, alongside other related configuration tips.

Setting Up the Spring Boot Application

First, ensure you have a basic Spring Boot setup. If you are creating a new project, you can use Spring Initializr or configure it manually. Here's a quick setup guide using Maven:

xml
1<dependencies>
2    <dependency>
3        <groupId>org.springframework.boot</groupId>
4        <artifactId>spring-boot-starter-web</artifactId>
5    </dependency>
6    <dependency>
7        <groupId>org.springframework.boot</groupId>
8        <artifactId>spring-boot-starter-thymeleaf</artifactId>
9    </dependency>
10</dependencies>

If you prefer Gradle, your build.gradle will look like this:

groovy
1dependencies {
2    implementation 'org.springframework.boot:spring-boot-starter-web'
3    implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
4}

Mapping Root URL to index.html

The simplest way to map the root URL to the index.html file is to place your index.html inside the src/main/resources/static directory. Spring Boot automatically maps static resources located in src/main/resources/static, src/main/resources/public, src/main/resources/resources, and src/main/resources/META-INF/resources as they are served directly.

With the index.html file under src/main/resources/static, any request to the root URL ("/") will automatically serve this file.

Custom Controller for Advanced Routing

For more complex routing requirements (e.g., conditionally rendering different pages), you may need to define a custom controller.

Here is an example of how you might define a controller to handle the root URL:

java
1import org.springframework.stereotype.Controller;
2import org.springframework.web.bind.annotation.GetMapping;
3
4@Controller
5public class HomeController {
6
7    @GetMapping("/")
8    public String index() {
9        return "index"; // returns the view name, typically a .html file in the templates directory
10    }
11}

In this scenario, index.html should reside in src/main/resources/templates if you are using a templating engine like Thymeleaf, rather than serving static content.

Configuring Welcome Page

You can also set a welcome page using Spring Boot's application properties. Add the following to src/main/resources/application.properties:

properties
spring.web.resources.add-mappings=true
spring.web.resources.static-locations=classpath:/static/

This configuration allows Spring Boot to automatically serve index.html from the specified classpath location at the root URL.

Creating an Example index.html

Here’s a simple example of what your index.html might look like:

html
1<!DOCTYPE html>
2<html lang="en">
3<head>
4    <meta charset="UTF-8">
5    <meta name="viewport" content="width=device-width, initial-scale=1.0">
6    <title>Welcome to Spring Boot</title>
7</head>
8<body>
9    <h1>Hello, Spring Boot!</h1>
10    <p>This is the default index page.</p>
11</body>
12</html>

Summary Table

TopicDescription
Static Resource MappingPlace index.html under static, public, resources, or META-INF/resources for automatic mapping to "/" URL.
Custom ControllerUse @GetMapping("/") and return view name for advanced routing. File should be in templates directory.
Configuration Propertiesspring.web.resources.add-mappings=true to ensure static mappings are active.
File LocationStatic content in src/main/resources/static. Templates in src/main/resources/templates.

Additional Details and Tips

  • Disable Spring Boot Defaults: If you want to disable the default behavior of serving static resources, you can exclude the auto-configuration for static content by adding @SpringBootApplication(exclude = &#123;WebMvcAutoConfiguration.class&#125;).
  • Use of Other Templating Engines: If you use other templates like Freemarker or Mustache, ensure appropriate view resolvers are configured.
  • Custom Error Page: You can create a default error page by simply adding an error.html file in the static resource directory, which will be served when an error occurs.

In conclusion, Spring Boot makes routing straightforward both through auto-mapping static content and using custom controllers for dynamic routing needs. By leveraging Spring Boot's conventions, you can efficiently manage resources and customize behavior according to your application's requirements.

Related reading
Course
Intermediate
27 lessons
14 hours
OOD Fundamentals

Master object-oriented design from first principles, SOLID, design patterns, and classic interview problems with hands-on coding.

View the course
Track what you have practised

A free account saves your progress, solutions and study plan across every problem on Codemia.

Interview Questions practice on Codemia

Over 8,000 real interview questions from top companies, searchable by company and role.

Browse interview questions
Codemia
© 2026 Codemia
Resources
Legal
Social
All Rights Reserved.