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

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