Package fr.metabocloud.core.api

Class RootApi

java.lang.Object

fr.metabocloud.core.api.RootApi

@CrossOrigin(origins="*",
             maxAge=3600L)
@RestController
public class RootApi
extends Object

Controller for the root of the REST API "/"

Since:

1.0.0

Author:

Faustine Souc

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RootApi()	Protected constructor

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<String>	getRoot()	Handle GET requests to the root `/` endpoint.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RootApi

protected RootApi()

Protected constructor

Method Details

getRoot

@GetMapping("/")
public org.springframework.http.ResponseEntity<String> getRoot()

Handle GET requests to the root `/` endpoint. Return a message at the application root to redirect to the OpenAPI documentation.

Returns:

The message with the link of the OpenAPI documentation