Class RootRestController


  • @RestController
    @RequestMapping("/api/v3")
    public class RootRestController
    extends java.lang.Object
    Rest controller for the V3 API root.
    Since:
    3.0.0
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.springframework.hateoas.EntityModel<java.util.Map<java.lang.String,​java.lang.String>> getRoot()
      Get a simple HAL+JSON object which represents the various links available in Genie REST API as an entry point.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • RootRestController

        @Autowired
        public RootRestController​(RootModelAssembler rootModelAssembler)
        Constructor.
        Parameters:
        rootModelAssembler - The assembler to use to construct resources.
    • Method Detail

      • getRoot

        @GetMapping(produces="application/hal+json")
        @ResponseStatus(OK)
        public org.springframework.hateoas.EntityModel<java.util.Map<java.lang.String,​java.lang.String>> getRoot()
        Get a simple HAL+JSON object which represents the various links available in Genie REST API as an entry point.
        Returns:
        the root resource containing various links to the real APIs