/samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/api/UserApi.java

https://github.com/OpenAPITools/openapi-generator · Java · 217 lines · 128 code · 27 blank · 62 comment · 3 complexity · 24d82117909bf0c2799458f5988a905e MD5 · raw file

  1. /**
  2. * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech) (5.0.0-SNAPSHOT).
  3. * https://openapi-generator.tech
  4. * Do not edit the class manually.
  5. */
  6. package org.openapitools.virtualan.api;
  7. import java.util.List;
  8. import org.openapitools.virtualan.model.User;
  9. import io.swagger.annotations.*;
  10. import io.virtualan.annotation.ApiVirtual;
  11. import io.virtualan.annotation.VirtualService;
  12. import org.springframework.http.HttpStatus;
  13. import org.springframework.http.MediaType;
  14. import org.springframework.http.ResponseEntity;
  15. import org.springframework.validation.annotation.Validated;
  16. import org.springframework.web.bind.annotation.*;
  17. import org.springframework.web.context.request.NativeWebRequest;
  18. import org.springframework.web.multipart.MultipartFile;
  19. import javax.validation.Valid;
  20. import javax.validation.constraints.*;
  21. import java.util.List;
  22. import java.util.Map;
  23. import java.util.Optional;
  24. @javax.annotation.Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
  25. @Validated
  26. @Api(value = "user", description = "the user API")
  27. @VirtualService
  28. public interface UserApi {
  29. default Optional<NativeWebRequest> getRequest() {
  30. return Optional.empty();
  31. }
  32. /**
  33. * POST /user : Create user
  34. * This can only be done by the logged in user.
  35. *
  36. * @param body Created user object (required)
  37. * @return successful operation (status code 200)
  38. */
  39. @ApiVirtual
  40. @ApiOperation(value = "Create user", nickname = "createUser", notes = "This can only be done by the logged in user.", tags={ "user", })
  41. @ApiResponses(value = {
  42. @ApiResponse(code = 200, message = "successful operation") })
  43. @PostMapping(
  44. value = "/user"
  45. )
  46. default ResponseEntity<Void> createUser(@ApiParam(value = "Created user object" ,required=true ) @Valid @RequestBody User body) {
  47. return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
  48. }
  49. /**
  50. * POST /user/createWithArray : Creates list of users with given input array
  51. *
  52. * @param body List of user object (required)
  53. * @return successful operation (status code 200)
  54. */
  55. @ApiVirtual
  56. @ApiOperation(value = "Creates list of users with given input array", nickname = "createUsersWithArrayInput", notes = "", tags={ "user", })
  57. @ApiResponses(value = {
  58. @ApiResponse(code = 200, message = "successful operation") })
  59. @PostMapping(
  60. value = "/user/createWithArray"
  61. )
  62. default ResponseEntity<Void> createUsersWithArrayInput(@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List<User> body) {
  63. return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
  64. }
  65. /**
  66. * POST /user/createWithList : Creates list of users with given input array
  67. *
  68. * @param body List of user object (required)
  69. * @return successful operation (status code 200)
  70. */
  71. @ApiVirtual
  72. @ApiOperation(value = "Creates list of users with given input array", nickname = "createUsersWithListInput", notes = "", tags={ "user", })
  73. @ApiResponses(value = {
  74. @ApiResponse(code = 200, message = "successful operation") })
  75. @PostMapping(
  76. value = "/user/createWithList"
  77. )
  78. default ResponseEntity<Void> createUsersWithListInput(@ApiParam(value = "List of user object" ,required=true ) @Valid @RequestBody List<User> body) {
  79. return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
  80. }
  81. /**
  82. * DELETE /user/{username} : Delete user
  83. * This can only be done by the logged in user.
  84. *
  85. * @param username The name that needs to be deleted (required)
  86. * @return Invalid username supplied (status code 400)
  87. * or User not found (status code 404)
  88. */
  89. @ApiVirtual
  90. @ApiOperation(value = "Delete user", nickname = "deleteUser", notes = "This can only be done by the logged in user.", tags={ "user", })
  91. @ApiResponses(value = {
  92. @ApiResponse(code = 400, message = "Invalid username supplied"),
  93. @ApiResponse(code = 404, message = "User not found") })
  94. @DeleteMapping(
  95. value = "/user/{username}"
  96. )
  97. default ResponseEntity<Void> deleteUser(@ApiParam(value = "The name that needs to be deleted",required=true) @PathVariable("username") String username) {
  98. return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
  99. }
  100. /**
  101. * GET /user/{username} : Get user by user name
  102. *
  103. * @param username The name that needs to be fetched. Use user1 for testing. (required)
  104. * @return successful operation (status code 200)
  105. * or Invalid username supplied (status code 400)
  106. * or User not found (status code 404)
  107. */
  108. @ApiVirtual
  109. @ApiOperation(value = "Get user by user name", nickname = "getUserByName", notes = "", response = User.class, tags={ "user", })
  110. @ApiResponses(value = {
  111. @ApiResponse(code = 200, message = "successful operation", response = User.class),
  112. @ApiResponse(code = 400, message = "Invalid username supplied"),
  113. @ApiResponse(code = 404, message = "User not found") })
  114. @GetMapping(
  115. value = "/user/{username}",
  116. produces = { "application/xml", "application/json" }
  117. )
  118. default ResponseEntity<User> getUserByName(@ApiParam(value = "The name that needs to be fetched. Use user1 for testing.",required=true) @PathVariable("username") String username) {
  119. getRequest().ifPresent(request -> {
  120. for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
  121. if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) {
  122. String exampleString = "{ \"firstName\" : \"firstName\", \"lastName\" : \"lastName\", \"password\" : \"password\", \"userStatus\" : 6, \"phone\" : \"phone\", \"id\" : 0, \"email\" : \"email\", \"username\" : \"username\" }";
  123. ApiUtil.setExampleResponse(request, "application/json", exampleString);
  124. break;
  125. }
  126. if (mediaType.isCompatibleWith(MediaType.valueOf("application/xml"))) {
  127. String exampleString = "<User> <id>123456789</id> <username>aeiou</username> <firstName>aeiou</firstName> <lastName>aeiou</lastName> <email>aeiou</email> <password>aeiou</password> <phone>aeiou</phone> <userStatus>123</userStatus> </User>";
  128. ApiUtil.setExampleResponse(request, "application/xml", exampleString);
  129. break;
  130. }
  131. }
  132. });
  133. return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
  134. }
  135. /**
  136. * GET /user/login : Logs user into the system
  137. *
  138. * @param username The user name for login (required)
  139. * @param password The password for login in clear text (required)
  140. * @return successful operation (status code 200)
  141. * or Invalid username/password supplied (status code 400)
  142. */
  143. @ApiVirtual
  144. @ApiOperation(value = "Logs user into the system", nickname = "loginUser", notes = "", response = String.class, tags={ "user", })
  145. @ApiResponses(value = {
  146. @ApiResponse(code = 200, message = "successful operation", response = String.class),
  147. @ApiResponse(code = 400, message = "Invalid username/password supplied") })
  148. @GetMapping(
  149. value = "/user/login",
  150. produces = { "application/xml", "application/json" }
  151. )
  152. default ResponseEntity<String> loginUser(@NotNull @ApiParam(value = "The user name for login", required = true) @Valid @RequestParam(value = "username", required = true) String username,@NotNull @ApiParam(value = "The password for login in clear text", required = true) @Valid @RequestParam(value = "password", required = true) String password) {
  153. return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
  154. }
  155. /**
  156. * GET /user/logout : Logs out current logged in user session
  157. *
  158. * @return successful operation (status code 200)
  159. */
  160. @ApiVirtual
  161. @ApiOperation(value = "Logs out current logged in user session", nickname = "logoutUser", notes = "", tags={ "user", })
  162. @ApiResponses(value = {
  163. @ApiResponse(code = 200, message = "successful operation") })
  164. @GetMapping(
  165. value = "/user/logout"
  166. )
  167. default ResponseEntity<Void> logoutUser() {
  168. return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
  169. }
  170. /**
  171. * PUT /user/{username} : Updated user
  172. * This can only be done by the logged in user.
  173. *
  174. * @param username name that need to be deleted (required)
  175. * @param body Updated user object (required)
  176. * @return Invalid user supplied (status code 400)
  177. * or User not found (status code 404)
  178. */
  179. @ApiVirtual
  180. @ApiOperation(value = "Updated user", nickname = "updateUser", notes = "This can only be done by the logged in user.", tags={ "user", })
  181. @ApiResponses(value = {
  182. @ApiResponse(code = 400, message = "Invalid user supplied"),
  183. @ApiResponse(code = 404, message = "User not found") })
  184. @PutMapping(
  185. value = "/user/{username}"
  186. )
  187. default ResponseEntity<Void> updateUser(@ApiParam(value = "name that need to be deleted",required=true) @PathVariable("username") String username,@ApiParam(value = "Updated user object" ,required=true ) @Valid @RequestBody User body) {
  188. return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
  189. }
  190. }