Spring Boot API with Multiple Controllers?

Question

I am starting to learn Spring Boot. I am struggling to find an example with multiple RestControllers, which indicates to me that I may be doing something wrong. I am trying a very simple example: The goal is to make calls like the following:

localhost:8080/
localhost:8080/employees/bob
localhost:8080/departments

I can only get localhost:8080/ to display. The other calls return response: This application has no explicit mapping for /error, so you are seeing this as a fallback.

com.demo.departments
Department.java
DepartmentController.java

com.demo.employees
Employee.java
EmployeeController.java

com.demo
BootDemoApplication.java

Code:

package com.demo.departments
@RestController
@RequestMapping("/departments")
public class DepartmentController {


@RequestMapping("")
public String get(){
    return "test..";

}

@RequestMapping("/list")
public List<Department> getDepartments(){
    return null;

}

}
--------------------------------------------------------------------
package com.demo.employees
@RestController
@RequestMapping("/employees")
public class EmployeeController {

Employee e =new Employee();

@RequestMapping(value = "/{name}", method = RequestMethod.GET, produces = "application/json")
public Employee getEmployeeInJSON(@PathVariable String name) {

 e.setName(name);
 e.setEmail("[email protected]");

 return e;

}
}
-----------------------------------------------------------------------

package com.demo
@RestController
@SpringBootApplication

public class BootDemoApplication {

public static void main(String[] args) {
    SpringApplication.run(BootDemoApplication.class, args);
}

@RequestMapping("/")
String home(){
    return "<html> This is the home page for Boot Demo.</html>";
}

I don't think you need the preceeding "/" on the top level controller mappings. — ChiefTwoPencils
– ChiefTwoPencils, Commented May 22, 2016 at 5:57
This should work (tested it out). You didn't provide any controller for http://localhost:8080/ though, so perhaps the mistake is there. — Dimitri Mestdagh
– Dimitri Mestdagh, Commented May 22, 2016 at 12:16
You are returning JSON, but aren't requesting it (the browser expect HTML) so no method for handling the request is found. — M. Deinum
– M. Deinum, Commented May 22, 2016 at 14:16
Yes I am, Employee is a POJO. Its not calling any of the code in the other 2 classes in the debugger. It complains about mapping, not about results. — user1529412
– user1529412, Commented May 22, 2016 at 15:14

VietDD · Accepted Answer · 2017-08-05 12:18:10Z

I'm trying Spring Boot and got same problem, and just fixed it, I post my solution here because I think it maybe helpful for someone.

First, put application class ( which contain main method) at the root of controllers's package:

com.example.demo
              |
              +-> controller
              |      |
              |      +--> IndexController.java
              |      +--> LoginController.java
              |
              +-> Application.java

Application.java

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

Spring will scan all the components of sub-packages of demo package

IndexController.java (return index.html view)

package com.example.demo.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

@Controller
@RequestMapping(value = {""})
public class IndexController {

    @GetMapping(value = {""})
    public ModelAndView index() {
        ModelAndView modelAndView = new ModelAndView();
        modelAndView.setViewName("index");
        return modelAndView;
    }

}

LoginController.java (return login.html view)

package com.example.demo.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

@Controller
@RequestMapping(value = {"/login"})
public class LoginController {
    @GetMapping(value = {""})
    public ModelAndView login() {
        ModelAndView modelAndView = new ModelAndView();
        modelAndView.setViewName("login");
        return modelAndView;
    }
}

And now I can enter Index view : http://localhost:8080/demo/ and Login view : http://localhost:8080/demo/login

user1529412 · Accepted Answer · 2016-05-26 02:17:55Z

13

Apparently Controllers in different packages can't be seen with @springbootApplication notation in the main class. The solution explained here, https://kamwo.me/java-spring-boot-mvc-ontroller-not-called/.

edited May 26, 2016 at 2:17

answered May 25, 2016 at 3:21

user1529412

3,7667 gold badges29 silver badges44 bronze badges

Comments

Janac Meena · Accepted Answer · 2018-01-30 16:26:45Z

5

Make sure that the @SpringBootApplication class is in a package which is a level above all other packages that contain @RestControllers, or in the same package.

answered Jan 30, 2018 at 16:26

Janac Meena

3,67738 silver badges38 bronze badges

Comments

Ian Riley · Accepted Answer · 2016-09-01 18:55:08Z

4

For Spring-boot 1.3.x and up, passing a base package to SpringBootApplication should work:

@SpringBootApplication(scanBasePackages = {"com.demo"})
public class DemoBootApplication {
    // code
}

This worked for me on a similar application using spring-boot 1.4.0. For earlier versions of spring-boot, it appears you'll have forego using SpringBootApplication and instead use the following to get same effect as above:

@Configuration
@EnableAutoConfiguration
@ComponentScan(basePackages = {"com.demo"})
public class DemoBootApplication {
    // code
}

I found this in the comments on this blog post.

edited Sep 1, 2016 at 18:55

answered Sep 1, 2016 at 18:46

Ian Riley

4572 gold badges8 silver badges17 bronze badges

Comments

Red Boy · Accepted Answer · 2017-06-05 06:21:24Z

1

ComponentScan annotation works in most cases.

See below example, you could apply similar.
package com.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@ComponentScan(basePackages = {"com.demo"})
@SpringBootApplication
public class DemoApplication {

public static void main(String[] args) {
    SpringApplication.run(DemoApplication.class, args);
}
}

answered Jun 5, 2017 at 6:21

Red Boy

5,7893 gold badges34 silver badges49 bronze badges

Comments

Patricio Nicola · Accepted Answer · 2016-12-07 00:40:31Z

0

Try this

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Main {

    public static void main(String[] args) {

        Object[] sources = new Object[2];
        sources[0] = Controller1.class;
        sources[1] = Controller2.class;
        SpringApplication.run(sources, args);
    }

}

edited Dec 7, 2016 at 0:40

user6655984

answered Dec 6, 2016 at 23:55

Patricio Nicola

1

Comments

jovanchohan · Accepted Answer · 2019-02-28 17:58:58Z

0

I'm not sure if this is the right way to do it, but when I changed my 2nd Controllers annotation from @Controller to @RestController it started working.

answered Feb 28, 2019 at 17:58

jovanchohan

1532 silver badges3 bronze badges

Comments

Akhil · Accepted Answer · 2016-05-22 06:57:23Z

-1

Try below:-

@ComponentScan
@Configuration
@EnableAutoConfiguration
public class BootDemoApplication {

public static void main(String[] args) {

    SpringApplication.run(BootDemoApplication.class);
}
}

@RestController
@RequestMapping(value = "test", produces =    MediaType.APPLICATION_JSON_VALUE)
public class TestController {

@RequestMapping(method = RequestMethod.GET)
public String test() {
    return "from test method";
}

}

answered May 22, 2016 at 6:57

Akhil

1,2843 gold badges22 silver badges46 bronze badges

Collectives™ on Stack Overflow

Spring Boot API with Multiple Controllers?

8 Answers 8

Comments

Comments

Comments

Comments

Comments

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

8 Answers 8

Comments

Comments

Comments

Comments

Comments

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related