Documented Auth controller

Author: deepanshut041

build.gradle

@@ -41,9 +41,10 @@ dependencies {
 compileOnly 'org.projectlombok:lombok'
 annotationProcessor 'org.projectlombok:lombok'
 
-// swagger3
-compile "io.springfox:springfox-swagger2:3.0.0-SNAPSHOT"
-compile "io.springfox:springfox-swagger-ui:3.0.0-SNAPSHOT"
+// Swagger
+implementation ("io.springfox:springfox-swagger2:2.9.2") 
+implementation "io.springfox:springfox-swagger-ui:2.9.2"
+implementation "org.springframework.plugin:spring-plugin-core:1.2.0.RELEASE"
 
 // Mapstruct
 implementation "org.mapstruct:mapstruct:1.3.0.Final"

src/main/java/io/github/deepanshut041/serendeepia/SerendeepiaApplication.java

@@ -1,7 +1,13 @@
 package io.github.deepanshut041.serendeepia;
 
+import io.github.deepanshut041.serendeepia.domains.Role;
+import io.github.deepanshut041.serendeepia.repository.RoleRepository;
+import org.springframework.boot.ApplicationRunner;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.Bean;
+
+import java.util.stream.Stream;
 
 @SpringBootApplication
 public class SerendeepiaApplication {
@@ -10,4 +16,23 @@ public static void main(String[] args) {
 SpringApplication.run(SerendeepiaApplication.class, args);
 }
 
+@Bean
+ApplicationRunner init(RoleRepository repository) {
+Role[] roles = {
+new Role("ROLE_USER"), new Role("ROLE_ADMIN")
+};
+
+return args -> {
+Stream.of(roles).forEach(
+role -> {
+if(!repository.existsByName(role.getName())) {
+repository.save(role);
+}
+}
+);
+
+repository.findAll().forEach(System.out::println);
+};
+}
+
 }

src/main/java/io/github/deepanshut041/serendeepia/config/SecurityConfiguration.java

@@ -55,13 +55,10 @@ protected void configure(HttpSecurity http) throws Exception {
  .and()
  .authorizeRequests()
  .antMatchers(
- "/api/auth/**",
- "/api/v2/api-docs/**",
- "/swagger-ui.html/**",
- "/swagger-resources/**",
- "/favicon.ico", "/**/*.png", "/**/*.gif", "/**/*.svg", "/**/*.jpg", "/**/*.html", "/**/*.css", "/**/*.js"
-
- )
+ "/api/auth/**", "/**",
+ "/v2/api-docs", "/configuration/**", "/swagger*/**",
+ "/favicon.ico",
+ "/**/*.png", "/**/*.gif", "/**/*.svg", "/**/*.jpg", "/**/*.html", "/**/*.css", "/**/*.js")
  .permitAll().anyRequest().authenticated();
 
  http.addFilterBefore(tokenAuthenticationFilter(), UsernamePasswordAuthenticationFilter.class);

src/main/java/io/github/deepanshut041/serendeepia/config/SpringFoxConfig.java

@@ -10,10 +10,12 @@
 import springfox.documentation.service.Contact;
 import springfox.documentation.spi.DocumentationType;
 import springfox.documentation.spring.web.plugins.Docket;
+import springfox.documentation.swagger2.annotations.EnableSwagger2;
 
 import java.util.Optional;
 
 @Configuration
+@EnableSwagger2
 public class SpringFoxConfig {
 
  @Bean
@@ -26,12 +28,12 @@ public Docket api() {
  .build();
  }
  private ApiInfo apiInfo() {
- return new ApiInfoBuilder().title("Sarte REST API")
- .description("Shop Management REST API")
- .contact(new Contact("Squrlabs", "www.Squrlabs.com", "squrlabs@gmail.com"))
+ return new ApiInfoBuilder().title("Serendeepia REST API")
+ .description("Serendeepia Auth REST API")
+ .contact(new Contact("Deepanshu Tyagi", "deepanshut041.github.io", "deepanshut041@gmail.com"))
  .license("Apache 2.0")
  .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html")
- .version("0.0.1")
+ .version("1.0")
  .build();
  }
 

src/main/java/io/github/deepanshut041/serendeepia/config/WebMvcConfig.java

@@ -2,6 +2,7 @@
 
 import org.springframework.context.annotation.Configuration;
 import org.springframework.web.servlet.config.annotation.CorsRegistry;
+import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
 
 @Configuration
@@ -17,4 +18,12 @@ public void addCorsMappings(CorsRegistry registry) {
  .maxAge(MAX_AGE_SECS);
  }
 
+ @Override
+ public void addResourceHandlers(ResourceHandlerRegistry registry) {
+ registry.addResourceHandler("swagger-ui.html")
+ .addResourceLocations("classpath:/META-INF/resources/");
+ 
+ registry.addResourceHandler("/webjars/**")
+ .addResourceLocations("classpath:/META-INF/resources/webjars/");
+ }
 }

src/main/java/io/github/deepanshut041/serendeepia/controller/AuthController.java

@@ -1,5 +1,6 @@
 package io.github.deepanshut041.serendeepia.controller;
 
+import io.github.deepanshut041.serendeepia.domains.Role;
 import io.github.deepanshut041.serendeepia.domains.User;
 import io.github.deepanshut041.serendeepia.dto.ApiResponse;
 import io.github.deepanshut041.serendeepia.dto.AuthResponse;
@@ -9,6 +10,8 @@
 import io.github.deepanshut041.serendeepia.service.UserService;
 import io.github.deepanshut041.serendeepia.util.JwtTokenUtil;
 import io.github.deepanshut041.serendeepia.util.exception.BadRequestException;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiParam;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.ResponseEntity;
 import org.springframework.security.authentication.AuthenticationManager;
@@ -22,16 +25,16 @@
 import org.springframework.web.bind.annotation.RestController;
 
 import javax.validation.Valid;
+import java.util.List;
 
 @RestController
 @RequestMapping("/api/auth")
+@Api(value = "Authentication Route")
 public class AuthController {
 
  @Autowired
  private AuthenticationManager authenticationManager;
 
- @Autowired
- private PasswordEncoder passwordEncoder;
 
  @Autowired
  private JwtTokenUtil tokenUtil;
@@ -43,7 +46,9 @@ public class AuthController {
  private RoleService roleService;
 
  @PostMapping("/login")
- public ResponseEntity<?> authenticateUser(@Valid @RequestBody LoginDto loginDto) {
+ public ResponseEntity<?> authenticateUser(
+ @ApiParam(value = "LoginDto contains email and password", required = true)
+ @Valid @RequestBody LoginDto loginDto) {
 
  Authentication authentication = authenticationManager.authenticate(
  new UsernamePasswordAuthenticationToken(
@@ -59,22 +64,19 @@ public ResponseEntity<?> authenticateUser(@Valid @RequestBody LoginDto loginDto)
  }
 
  @PostMapping("/register")
- public ResponseEntity<?> registerUser(@Valid @RequestBody RegisterDto registerDto) {
+ public ResponseEntity<?> registerUser(
+ @ApiParam(value = "RegisterDto contains information regarding user", required = true)
+ @Valid @RequestBody RegisterDto registerDto) {
+
  if(userService.existsByEmail(registerDto.getEmail())) {
  throw new BadRequestException("Email address already in use.");
  }
 
- // Creating user's account
- User user = new User();
- user.setName(registerDto.getName());
- user.setEmail(registerDto.getEmail());
- user.setPassword(registerDto.getPassword());
- user.setPassword(passwordEncoder.encode(user.getPassword()));
- user.setRoles(roleService.findByName("ROLE_USER"));
+ List<Role> roles = roleService.findByName("ROLE_USER");
 
- userService.save(user);
+ userService.save(registerDto, roles);
 
- return ResponseEntity.ok(new ApiResponse(true, "User registered successfully@"));
+ return ResponseEntity.ok(new ApiResponse(true, "User registered successfully"));
  }
 
 }

src/main/java/io/github/deepanshut041/serendeepia/controller/HomeController.java

@@ -0,0 +1,16 @@
+package io.github.deepanshut041.serendeepia.controller;
+
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+import org.springframework.web.servlet.ModelAndView;
+
+@RequestMapping("")
+@Controller
+public class HomeController {
+
+ @RequestMapping(value = {"", "/"}, method = RequestMethod.GET)
+ public ModelAndView home(){
+ return new ModelAndView("redirect:/swagger-ui.html");
+ }
+}

src/main/java/io/github/deepanshut041/serendeepia/domains/Role.java

@@ -18,7 +18,11 @@ public class Role {
  @Column(unique = true, nullable = false)
  private String name;
 
- @ManyToMany(mappedBy = "roles")
- private Collection<User> users;
+// @ManyToMany(mappedBy = "roles", fetch = FetchType.LAZY)
+// private Collection<User> users;
+
+ public Role (String name){
+ this.name = name;
+ }
 
 }

src/main/java/io/github/deepanshut041/serendeepia/dto/LoginDto.java

@@ -1,16 +1,24 @@
 package io.github.deepanshut041.serendeepia.dto;
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
+import lombok.NoArgsConstructor;
 
 import javax.validation.constraints.Email;
 import javax.validation.constraints.NotBlank;
 
 @Data
+@NoArgsConstructor
+@ApiModel(value = "Login Request", description = "This Login request model")
 public class LoginDto {
+
  @NotBlank
  @Email
+ @ApiModelProperty(notes = "Your email for login", required = true)
  private String email;
 
  @NotBlank
+ @ApiModelProperty(notes = "Your password for login", required = true)
  private String password;
 }

src/main/java/io/github/deepanshut041/serendeepia/dto/ProfileDto.java

@@ -0,0 +1,23 @@
+package io.github.deepanshut041.serendeepia.dto;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@AllArgsConstructor
+@NoArgsConstructor
+@ApiModel(value = "Profile Response", description = "This profile response model")
+public class ProfileDto {
+
+ @ApiModelProperty(notes = "User id, It is unique")
+ private Long id;
+
+ @ApiModelProperty(notes = "User email, It is unique")
+ private String email;
+
+ @ApiModelProperty(notes = "Full name user")
+ private String name;
+}