Java tutorial
/* * * Copyright 2015 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * * */ package io.github.robwin.swagger2markup.petstore.controller; import io.github.robwin.swagger2markup.petstore.Responses; import io.github.robwin.swagger2markup.petstore.model.User; import io.github.robwin.swagger2markup.petstore.repository.MapBackedRepository; import io.swagger.annotations.*; import org.springframework.http.HttpStatus; import org.springframework.http.MediaType; import org.springframework.http.ResponseEntity; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.*; import java.util.List; import static org.springframework.web.bind.annotation.RequestMethod.*; @Controller @RequestMapping(value = "/users", produces = MediaType.APPLICATION_JSON_VALUE) @Api(value = "/users", tags = "Users", description = "Operations about user") public class UserController { UserRepository userRepository = new UserRepository(); static class UserRepository extends MapBackedRepository<String, User> { } @RequestMapping(method = POST) @ResponseBody @ApiOperation(value = "Create user", notes = "This can only be done by the logged in user.") public ResponseEntity<User> createUser( @RequestBody @ApiParam(value = "Created user object", required = true) User user) { userRepository.add(user); return new ResponseEntity<User>(user, HttpStatus.OK); } @RequestMapping(value = "/createWithArray", method = POST) @ResponseBody @ApiOperation(value = "Creates list of users with given input array") public ResponseEntity<User> createUsersWithArrayInput( @ApiParam(value = "List of user object", required = true) User[] users) { for (User user : users) { userRepository.add(user); } return Responses.ok(); } @RequestMapping(value = "/createWithList", method = POST) @ResponseBody @ApiOperation(value = "Creates list of users with given input array") public ResponseEntity<String> createUsersWithListInput( @ApiParam(value = "List of user object", required = true) List<User> users) { for (User user : users) { userRepository.add(user); } return Responses.ok(); } @RequestMapping(value = "/{username}", method = PUT) @ResponseBody @ApiOperation(value = "Updated user", notes = "This can only be done by the logged in user.") @ApiResponses(value = { @ApiResponse(code = 400, message = "Invalid user supplied", responseHeaders = { @ResponseHeader(name = "X-Rate-Limit-Limit", description = "The number of allowed requests in the current period"), @ResponseHeader(name = "X-Rate-Limit-Remaining", description = "The number of remaining requests in the current period") }), @ApiResponse(code = 404, message = "User not found", responseHeaders = { @ResponseHeader(name = "X-Rate-Limit-Limit", description = "The number of allowed requests in the current period"), @ResponseHeader(name = "X-Rate-Limit-Remaining", description = "The number of remaining requests in the current period") }) }) public ResponseEntity<String> updateUser( @ApiParam(value = "name that need to be deleted", required = true) @PathVariable("username") String username, @ApiParam(value = "Updated user object", required = true) User user) { if (userRepository.get(username) != null) { userRepository.add(user); return Responses.ok(); } return Responses.notFound(); } @RequestMapping(value = "/{username}", method = DELETE) @ApiOperation(value = "Delete user", notes = "This can only be done by the logged in user.") @ApiResponses(value = { @ApiResponse(code = 400, message = "Invalid username supplied"), @ApiResponse(code = 404, message = "User not found") }) public ResponseEntity<String> deleteUser( @ApiParam(value = "The name that needs to be deleted", required = true) @PathVariable("username") String username) { if (userRepository.exists(username)) { userRepository.delete(username); return Responses.ok(); } return Responses.notFound(); } @RequestMapping(value = "/{username}", method = GET) @ApiOperation(value = "Get user by user name", response = User.class) @ApiResponses(value = { @ApiResponse(code = 400, message = "Invalid username supplied"), @ApiResponse(code = 404, message = "User not found") }) public ResponseEntity<User> getUserByName( @ApiParam(value = "The name that needs to be fetched. Use user1 for testing. ", required = true) @PathVariable("username") String username) { User user = userRepository.get(username); if (null != user) { return new ResponseEntity<User>(user, HttpStatus.OK); } else { throw new NotFoundException(404, "User not found"); } } @RequestMapping(value = "/login", method = GET) @ApiOperation(value = "Logs user into the system", response = String.class) @ApiResponses(value = { @ApiResponse(code = 400, message = "Invalid username/password supplied") }) public ResponseEntity<String> loginUser( @ApiParam(value = "The user name for login", required = true) @RequestParam("username") String username, @ApiParam(value = "The password for login in clear text", required = true) @RequestParam("password") String password) { return new ResponseEntity<String>("logged in user session:" + System.currentTimeMillis(), HttpStatus.OK); } @RequestMapping(value = "/logout", method = GET) @ApiOperation(value = "Logs out current logged in user session") public ResponseEntity<String> logoutUser() { return Responses.ok(); } }