dmv.spring.demo.rest.controller.apidocs

Interface UserRestApiDocs

All Known Implementing Classes:

UserRestController

public interface UserRestApiDocs

Swagger API Documentation. Each method is annotated with Springfox annotations (Swagger generator)

Author:

dmv

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<UserDTO>	createUser(User user, javax.servlet.http.HttpServletRequest request, org.springframework.web.util.UriComponentsBuilder uriBuilder)
org.springframework.http.ResponseEntity<Void>	deleteUser(Long userId)
org.springframework.http.ResponseEntity<UserDTO>	getUserByEmail(String email)
org.springframework.http.ResponseEntity<UserDTO>	getUserById(Long userId)
org.springframework.http.ResponseEntity<UserDTO>	updateUser(Long userId, User user, javax.servlet.http.HttpServletRequest request)

Method Detail

getUserById

org.springframework.http.ResponseEntity<UserDTO> getUserById(Long userId)

getUserByEmail

org.springframework.http.ResponseEntity<UserDTO> getUserByEmail(String email)
                                                         throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

createUser

org.springframework.http.ResponseEntity<UserDTO> createUser(User user,
                                                            javax.servlet.http.HttpServletRequest request,
                                                            org.springframework.web.util.UriComponentsBuilder uriBuilder)
                                                     throws URISyntaxException

Throws:

URISyntaxException

updateUser

org.springframework.http.ResponseEntity<UserDTO> updateUser(Long userId,
                                                            User user,
                                                            javax.servlet.http.HttpServletRequest request)
                                                     throws URISyntaxException

Throws:

URISyntaxException

deleteUser

org.springframework.http.ResponseEntity<Void> deleteUser(Long userId)