org.codehaus.mojo.servicedocgen.example

Interface DemoRestService

@Path(value="/demo/v1")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public interface DemoRestService

This is a cool REST-Service to demonstrate servicedocgen-maven-plugin.

Author:

hohwille

Method Summary

Modifier and Type	Method and Description
void	deleteString(long id) Deletes the DemoTo with the given id.
DemoTo<String>	findString(long id) Finds the DemoTo with the given id.
List<DemoTo<Long>>	saveLongs(List<DemoTo<Long>> objects) Saves the given DemoTos.
DemoTo<String>	saveString(DemoTo<String> object) Saves the given DemoTo.
void	testError() Test operation that always throws an error.

Method Detail

findString

@GET
 @Path(value="/string/{id}")
DemoTo<String> findString(@PathParam(value="id")
                                                            long id)

Finds the DemoTo with the given id.

Parameters:

id - the primary key of the requested object.

Returns:

the object with the given id.

saveString

@POST
 @Path(value="/string")
DemoTo<String> saveString(DemoTo<String> object)

Saves the given DemoTo.

Parameters:

object - the object to save.

Returns:

the updated object with id and version from database.

deleteString

@DELETE
 @Path(value="/string/{id}")
void deleteString(@PathParam(value="id")
                                                       long id)

Deletes the DemoTo with the given id.

Parameters:

id - the primary key of the object to delete.

saveLongs

@POST
 @Path(value="/longs")
List<DemoTo<Long>> saveLongs(List<DemoTo<Long>> objects)

Saves the given DemoTos.

Parameters:

objects - the objects to save.

Returns:

the updated objects with id and version from database.

testError

@GET
 @Path(value="/error")
void testError()
                                    throws IllegalStateException,
                                           UnsupportedOperationException

Test operation that always throws an error.

Throws:

IllegalStateException - in every case.

UnsupportedOperationException - never.