org.calrissian.restdoclet.example.spring

Class ExampleController

java.lang.Object

org.calrissian.restdoclet.example.spring.ExampleController

@Controller
@RequestMapping(value={"/foo","/bar"})
public class ExampleController
extends Object

Example implementation of a REST endpoints using spring to highlight documentation features.

Constructor Summary

Constructors

Constructor and Description
ExampleController()

Method Summary

Methods

Modifier and Type	Method and Description
String	getColor(String userId, boolean normalize) Retrieves the stored color for a particular user.
String	postExample(int value) Simply adds the value provided via the query parameter to a running total.
String	setColor(String userId, String value) Stores the color for a particular user

Methods inherited from class java.lang.Object

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

Constructor Detail

ExampleController

public ExampleController()

Method Detail

postExample

@RequestMapping(value="/add",
                method=POST,
                produces="text/plain")
@ResponseBody
public String postExample(@RequestParam
                                             int value)

Simply adds the value provided via the query parameter to a running total.

Parameters:

value - Value to be added to a running total.

Returns:

The current total.

getColor

@RequestMapping(value="/user/{name}/color",
                produces="text/plain")
@ResponseBody
public String getColor(@PathVariable(value="name")
                                          String userId,
                                          @RequestParam(required=false)
                                          boolean normalize)

Retrieves the stored color for a particular user.

Parameters:

userId - user id of the user.

normalize - Determines whether the result will be standardized

setColor

@RequestMapping(value="/user/{name}/color",
                method={POST,PUT},
                consumes="application/json",
                produces="text/plain")
@ResponseBody
public String setColor(@PathVariable(value="name")
                                          String userId,
                                          @RequestBody
                                          String value)

Stores the color for a particular user

Parameters:

userId - User id of the user.

value - The color value to store for the user