Content

/person

Concrete class: com.wadpam.docrest.test.PersonController

findByName()

Implementing Class: com.wadpam.docrest.test.PersonController

REST path: GET /person/{name}

Request parameters

Where Name Type Description
path name String

Response Codes

HTTP Response Code Message Description
200 When found
404 NOT FOUND When no user exists for specified name

Response Type: com.wadpam.docrest.test.Venue

Response Example

{
   "id":String,
   "name":String,
   "establishedYear":int,
   "location":{
      "latitude":double,
      "longitude":double
   }
}

delete()

Implementing Class: com.wadpam.docrest.test.PersonController

REST path: DELETE /person/{id}

Request parameters

Where Name Type Description
path id String

Response Codes

HTTP Response Code Message Description
- - -

Response Type: ${encoder.escapeHtml($method.returnType)}

Response Example

${method.json}

findAll()

Implementing Class: com.wadpam.docrest.test.AbstractController

REST path: GET /person/

Request parameters

Where Name Type Description
query offset int skip this number of entities before returning. Used for paging. Default is 0.
query limit int return this number of entities. Used for paging. Default is 10.

Response Codes

HTTP Response Code Message Description
- - -

Response Type: java.util.List

Response Example

[{
   "id":String,
   "name":String,
   "establishedYear":int,
   "location":{
      "latitude":double,
      "longitude":double
   }
}, ...
]

first()

Implementing Class: com.wadpam.docrest.test.AbstractController

REST path: GET /person/1st

Request parameters

Where Name Type Description
- - - -

Response Codes

HTTP Response Code Message Description
200 - When a first Entity exists

Response Type: org.springframework.http.ResponseEntity

Response Example

{
   "statusCode":HttpStatus
}

/venue

Concrete class: com.wadpam.docrest.test.VenueController

findByName()

Implementing Class: com.wadpam.docrest.test.VenueController

REST path: GET /venue/{name}

Request parameters

Where Name Type Description
path name String

Response Codes

HTTP Response Code Message Description
- - -

Response Type: ${encoder.escapeHtml($method.returnType)}

Response Example

${method.json}

update()

Implementing Class: com.wadpam.docrest.test.VenueController

REST path: POST /venue/{id}

Request parameters

Where Name Type Description
path id String The Venue id

Response Codes

HTTP Response Code Message Description
- - -

Response Type: ${encoder.escapeHtml($method.returnType)}

Response Example

${method.json}

delete()

Implementing Class: com.wadpam.docrest.test.VenueController

REST path: DELETE /venue/{id}

Request parameters

Where Name Type Description
path id String

Response Codes

HTTP Response Code Message Description
- - -

Response Type: ${encoder.escapeHtml($method.returnType)}

Response Example

${method.json}

last()

Implementing Class: com.wadpam.docrest.test.VenueController

REST path: GET /venue/

Request parameters

Where Name Type Description
- - - -

Response Codes

HTTP Response Code Message Description
- - -

Response Type: ${encoder.escapeHtml($method.returnType)}

Response Example

${method.json}

findAll()

Implementing Class: com.wadpam.docrest.test.AbstractController

REST path: GET /venue/

Request parameters

Where Name Type Description
query offset int skip this number of entities before returning. Used for paging. Default is 0.
query limit int return this number of entities. Used for paging. Default is 10.

Response Codes

HTTP Response Code Message Description
- - -

Response Type: java.util.List

Response Example

[,
...
]

first()

Implementing Class: com.wadpam.docrest.test.AbstractController

REST path: GET /venue/1st

Request parameters

Where Name Type Description
- - - -

Response Codes

HTTP Response Code Message Description
200 - When a first Entity exists

Response Type: org.springframework.http.ResponseEntity

Response Example

{
   "statusCode":HttpStatus
}