Serve index.html implicitly with Spring Boot

Question

I have a simple Spring Boot Starter Web application. I want to serve several static html files.

I know that I could serve static files with Spring Boot just simply putting then to /static subdirectory of my src/main/resources.

When I create file (for example) /static/docs/index.html, then I could access it via http://localhost:8080/docs/index.html.

What I want to achieve is to access this file simply with http://localgost:8080/docs where index.html is implicitly added by Spring.

Summary:

I need to serve static files in /static/{path}/index.html in resources via localhost:8080/{path} path.

I know that I could manually create mappings in controllers, but when there is many files to serve it becomes annoying.

Create one controller that automatically maps all of them?

dan1st
– dan1st

2020-10-01 11:43:43 +00:00
Commented Oct 1, 2020 at 11:43 — dan1st
– dan1st, Commented Oct 1, 2020 at 11:43
Did you find a way to do it?

geschema
– geschema

2023-01-06 19:32:18 +00:00
Commented Jan 6, 2023 at 19:32 — geschema
– geschema, Commented Jan 6, 2023 at 19:32
@geschema no, unfortunately not.

Vladimir Shefer
– Vladimir Shefer

2023-01-11 22:25:21 +00:00
Commented Jan 11, 2023 at 22:25 — Vladimir Shefer
– Vladimir Shefer, Commented Jan 11, 2023 at 22:25

Michal Drozd · Accepted Answer · 2020-10-01 12:08:00Z

2

This will work

@Configuration
public class AppConfig implements WebMvcConfigurer {

    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/docs").setViewName("forward:/docs/index.html");
    }
}

Or possible solution for all static subdirs (ugly version)

public void addViewControllers(ViewControllerRegistry registry) {
    File file;
    try {
        file = new ClassPathResource("static").getFile();
        String[] names = file.list();

        for(String name : names)
        {
            if (new File(file.getAbsolutePath() + "/" + name).isDirectory())
            {
                registry.addViewController("/" + name).setViewName("forward:/" + name +"/index.html");
            }
        }
    } catch (IOException e) {
        // TODO: handle error
        e.printStackTrace();
    }
}

edited Oct 1, 2020 at 12:08

answered Oct 1, 2020 at 11:49

Michal Drozd

1,3515 gold badges13 silver badges26 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Vladimir Shefer Over a year ago

thank you for your answer, but it still requires to create mapping per path.

Michal Drozd Over a year ago

or you could get all directories from static folder and call this line dynamically for each directory if you want have permanent solution. It is not nice but effective.

Collectives™ on Stack Overflow

Serve index.html implicitly with Spring Boot

Summary:

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

Summary:

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related