How to return a html page from a restful controller in spring boot

Question

I want to return a simple html page from controller  but I get only the name of the file not its content  Why   This is my controller code    RestController public class HomeController         RequestMapping          public String welcome             return  login             This is my project structure

User · Answer

You get only the name because you return only the name return "login";. It's @RestController and this controller returns data rather than a view; because of this, you get only content that you return from method.

If you want to show view with this name you need to use Spring MVC, see this example.

User · Answer

Controller public class HomeController         RequestMapping method   RequestMethod GET  value    quot   quot       public ModelAndView welcome             ModelAndView modelAndView   new ModelAndView            modelAndView setViewName  quot login html quot            return modelAndView           This will return the Login html File  The Login html should be inside the static Folder  Note  thymeleaf dependency is not added  RestController public class HomeController         RequestMapping method   RequestMethod GET  value    quot   quot       public String welcome             return  quot login quot            This will return the String login

User · Answer

You can solve this in two ways   First way  If you wish to keep using REST you have to you a ModelAndView object to render a HTML page  An example is being posted by Happy Nguyen and I am posting it once more here    RequestMapping      public ModelAndView index          ModelAndView modelAndView   new ModelAndView        modelAndView setViewName  index        return modelAndView      Second Way  If it is not important weather you keep using REST or not  so you can just change the  RestController to  Controller and make sure that you have already added Thymeleaf template engine

User · Answer

The most correct and modern form is to use IoC to put dependencies into the endpoint method  like the thymeleaf Model instance       Controller   public class GreetingController            GetMapping   greeting            public String greeting               RequestParam name  name   required false  defaultValue  World   String name  Model model                 model addAttribute  name   name                 return  greeting                    returns the already proccessed model from src main resources templates greeting html               See complete example at  https   spring io guides gs serving-web-content

User · Answer

The answer from Kukkuz did not work for me until I added in this dependency into the pom file    lt  -- Spring boot Thymeleaf -- gt   lt dependency gt       lt groupId gt org springframework boot lt  groupId gt       lt artifactId gt spring-boot-starter-thymeleaf lt  artifactId gt   lt  dependency gt    From the guide here   As well as updating the registry resources as outlined here    It then started working just fine  If anyone in the future runs into the same issue and following the first answer does not solve your problem  follow these 2 other steps after utilizing the code in  Kukkuz s answer and see if that makes a difference

User · Answer

Follow below steps   Must put the html files in resources templates   Replace the  RestController with  Controller  Remove if you are using any view resolvers   Your controller method should return file name of view without extension like return  quot index quot   Include the below dependencies   lt dependency gt       lt groupId gt org springframework boot lt  groupId gt       lt artifactId gt spring-boot-starter-web lt  artifactId gt   lt  dependency gt   lt dependency gt       lt groupId gt org springframework boot lt  groupId gt       lt artifactId gt spring-boot-starter-thymeleaf lt  artifactId gt   lt  dependency gt   lt dependency gt       lt groupId gt org springframework boot lt  groupId gt       lt artifactId gt spring-boot-devtools lt  artifactId gt   lt  dependency gt

User · Answer

You should use login html  And replace RestController with Controller

User · Answer

I know this is old but maybe it helps someone  To do this in a RestController  return a String that is the actual HTML code  then the browser will know what to display

User · Answer

I m not using Thymeleaf and the only way it worked for me was with  Controller in the class and    RequestMapping method   RequestMethod GET  value        public String index         return  index html

User · Answer

You can try using ModelAndView    RequestMapping      public ModelAndView index          ModelAndView modelAndView   new ModelAndView        modelAndView setViewName  index        return modelAndView

User · Answer

When using  RestController like this    RestController public class HomeController         RequestMapping          public String welcome             return  login             This is the same as you do like this in a normal controller    Controller public class HomeController         RequestMapping           ResponseBody     public String welcome             return  login             Using  ResponseBody returns return  login   as a String object  Any object you return will be attached as payload in the HTTP body as JSON   This is why you are getting just login in the response

User · Answer

Replace  RestController with  Controller

User · Answer

The String you return here    return  login     Is actually the whole content what you send back to the browser   If you want to have the content of a file to be sent back  one way is    Open file Read contents into String Return the value   You can go by with this answer on the question Spring boot service to download a file

User · Answer

I did three things   Put the HTML page in  project basedir  resources static myPage html  Switch  RestController to  Controller  This is my controller    RequestMapping method   RequestMethod GET  value    quot   quot   public String aName         return  quot myPage html quot      No particular dependency is needed

User · Answer

Replace  Restcontroller with  controller   Restcontroller returns only content not html and jsp pages

User · Answer

Controller public class WebController    GetMapping       public String homePage         return  index

[java] How to return a html page from a restful controller in spring boot?

Examples related to java

Examples related to html

Examples related to spring

Examples related to spring-boot

Examples related to controller