openApi config

Author: purshink

spring-backend/pom.xml

@@ -18,6 +18,23 @@
  <java.version>11</java.version>
  </properties>
  <dependencies>
+ <dependency>
+ <groupId>org.springframework.boot</groupId>
+ <artifactId>spring-boot-starter-web</artifactId>
+ </dependency>
+
+ <dependency>
+ <groupId>org.springdoc</groupId>
+ <artifactId>springdoc-openapi-ui</artifactId>
+ <version>1.6.4</version>
+ </dependency>
+
+ <dependency>
+ <groupId>org.webjars</groupId>
+ <artifactId>swagger-ui</artifactId>
+ <version>4.10.3</version>
+ </dependency>
+
  <dependency>
  <groupId>com.cloudinary</groupId>
  <artifactId>cloudinary-taglib</artifactId>
@@ -42,7 +59,6 @@
  <optional>true</optional>
  </dependency>
 
-
  <dependency>
  <groupId>mysql</groupId>
  <artifactId>mysql-connector-java</artifactId>

spring-backend/src/main/java/backend/hobbiebackend/config/OpenApi30Config.java

@@ -0,0 +1,19 @@
+package backend.hobbiebackend.config;
+
+import io.swagger.v3.oas.annotations.OpenAPIDefinition;
+import io.swagger.v3.oas.annotations.enums.SecuritySchemeType;
+import io.swagger.v3.oas.annotations.info.Info;
+import io.swagger.v3.oas.annotations.security.SecurityScheme;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+@OpenAPIDefinition(info = @Info(title = "My API", version = "v3"))
+@SecurityScheme(
+ name = "bearerAuth",
+ type = SecuritySchemeType.HTTP,
+ bearerFormat = "JWT",
+ scheme = "bearer"
+)
+public class OpenApi30Config {
+
+}

spring-backend/src/main/java/backend/hobbiebackend/config/SecurityConfiguration.java

@@ -8,6 +8,7 @@
 import org.springframework.security.authentication.AuthenticationManager;
 import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder;
 import org.springframework.security.config.annotation.web.builders.HttpSecurity;
+import org.springframework.security.config.annotation.web.builders.WebSecurity;
 import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
 import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
 import org.springframework.security.config.http.SessionCreationPolicy;
@@ -38,6 +39,14 @@ protected void configure(AuthenticationManagerBuilder auth) throws Exception {
  auth.userDetailsService(hobbieUserDetailsService);
  }
 
+ @Override
+ public void configure(final WebSecurity webSecurity) {
+ webSecurity.ignoring().antMatchers(
+ "/v3/api-docs/**",
+ "/swagger-ui/**",
+ "/swagger-ui/index.html");
+ }
+
  @Override
  @Bean
  public AuthenticationManager authenticationManagerBean() throws Exception {
@@ -50,7 +59,8 @@ protected void configure(HttpSecurity http) throws Exception {
  http.csrf()
  .disable()
  .authorizeRequests()
- .antMatchers("/register","/signup","/authenticate", "/notification", "/password")
+ .antMatchers("/register","/signup","/authenticate", "/notification", "/password","/swagger-ui/index.html","/v3/api-docs","/configuration/ui","/swagger-resources/**",
+ "/configuration/security","/swagger-ui/*","/webjars/**","/v3/**")
  .permitAll()
  .anyRequest()
  .authenticated()

spring-backend/src/main/java/backend/hobbiebackend/service/HobbyService.java

@@ -18,7 +18,6 @@ public interface HobbyService {
 
  boolean deleteHobby(long id) throws Exception;
 
-// List<Hobby> initHobbyOffers();
 
  Set<Hobby> findHobbyMatches(String username);
 

spring-backend/src/main/java/backend/hobbiebackend/web/HobbyController.java

@@ -8,6 +8,8 @@
 import backend.hobbiebackend.service.HobbyService;
 import backend.hobbiebackend.service.LocationService;
 import backend.hobbiebackend.service.UserService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.security.SecurityRequirement;
 import org.modelmapper.ModelMapper;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
@@ -68,18 +70,21 @@ public ResponseEntity<HttpStatus> saveHobby(@RequestBody HobbyInfoDto info){
  }
 
  @GetMapping(value ="/is-saved")
+ @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
  public boolean isHobbySaved(@RequestParam Long id, @RequestParam String username){
  return this.hobbyService.isHobbySaved(id, username);
  }
 
  @GetMapping(value ="/{id}")
+ @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
  public Hobby getHobbyDetails(@PathVariable Long id){
 
  return this.hobbyService.findHobbieById(id);
  }
 
 
  @PostMapping ("/save")
+ @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
  public ResponseEntity<Long> save(@RequestParam Long id, @RequestParam String username){
  Hobby hobby = this.hobbyService.findHobbieById(id);
 
@@ -94,6 +99,7 @@ public ResponseEntity<Long> save(@RequestParam Long id, @RequestParam String use
  }
 
  @DeleteMapping("/remove")
+ @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
  public ResponseEntity<Long> removeHobby(@RequestParam Long id, @RequestParam String username){
 
  Hobby hobby = this.hobbyService.findHobbieById(id);
@@ -109,6 +115,7 @@ public ResponseEntity<Long> removeHobby(@RequestParam Long id, @RequestParam Str
 
 
  @PutMapping
+ @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
  public ResponseEntity<?> updateHobby(@RequestBody HobbyInfoUpdateDto info) throws Exception {
  Hobby offer = this.modelMapper.map(info, Hobby.class);
  Category category = this.categoryService.findByName(info.getCategory());
@@ -121,6 +128,7 @@ public ResponseEntity<?> updateHobby(@RequestBody HobbyInfoUpdateDto info) throw
  }
 
  @DeleteMapping("/{id}")
+ @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
  public ResponseEntity<Long> deleteHobby(@PathVariable Long id) throws Exception {
  boolean isRemoved = this.hobbyService.deleteHobby(id);
 
@@ -131,6 +139,7 @@ public ResponseEntity<Long> deleteHobby(@PathVariable Long id) throws Exception
  }
 
  @GetMapping("/saved")
+ @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
  public List<Hobby> savedHobbies(@RequestParam String username) {
  AppClient appClient = this.userService.findAppClientByUsername(username);
  return this.hobbyService.findSavedHobbies(appClient);

spring-backend/src/main/java/backend/hobbiebackend/web/HomeController.java

@@ -7,6 +7,8 @@
 import backend.hobbiebackend.service.HobbyService;
 import backend.hobbiebackend.service.UserRoleService;
 import backend.hobbiebackend.service.UserService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.security.SecurityRequirement;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.*;
 
@@ -28,6 +30,7 @@ public HomeController(HobbyService hobbyService) {
  }
 
  @GetMapping( "/home")
+ @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
  public Set<Hobby> hobbiesShow(@RequestParam String username,@RequestParam String role) {
 
  if(role.equals("user")){

spring-backend/src/main/java/backend/hobbiebackend/web/TestController.java

@@ -3,6 +3,8 @@
 
 import backend.hobbiebackend.model.entities.Test;
 import backend.hobbiebackend.service.TestService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.security.SecurityRequirement;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
@@ -25,6 +27,7 @@ public TestController(TestService testService) {
 
 
  @PostMapping("/test")
+ @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
  public ResponseEntity<HttpStatus> saveTestResults(@RequestBody Test results) {
  this.testService.saveTestResults(results);
  return new ResponseEntity<>(HttpStatus.CREATED);

spring-backend/src/main/java/backend/hobbiebackend/web/UserController.java

@@ -16,6 +16,8 @@
 import backend.hobbiebackend.service.NotificationService;
 import backend.hobbiebackend.service.UserService;
 import backend.hobbiebackend.utility.JWTUtility;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.security.SecurityRequirement;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
@@ -49,7 +51,6 @@ public UserController(UserService userService, PasswordEncoder passwordEncoder,
  this.passwordEncoder = passwordEncoder;
  this.notificationService = notificationService;
  this.jwtUtility = jwtUtility;
-
  this.authenticationManager = authenticationManager;
  this.hobbieUserDetailsService = hobbieUserDetailsService;
  }
@@ -72,7 +73,6 @@ public ResponseEntity<?> signup(@RequestBody AppClientSignUpDto user){
  @PostMapping("/register")
  public ResponseEntity<?> registerBusiness(@RequestBody BusinessRegisterDto business){
 
-
  if(this.userService.businessExists(business.getBusinessName() ) || this.userService.userExists(business.getUsername(), business.getEmail())){
  throw new RuntimeException("Username or email address already in use.");
  }
@@ -86,17 +86,20 @@ public ResponseEntity<?> registerBusiness(@RequestBody BusinessRegisterDto busin
 
 
  @GetMapping("/client")
+ @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
  public AppClient showUserDetails(@RequestParam String username) {
  return this.userService.findAppClientByUsername(username);
  }
 
 
  @GetMapping("/business")
+ @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
  public BusinessOwner showBusinessDetails(@RequestParam String username) {
  return this.userService.findBusinessByUsername(username);
  }
 
  @PutMapping("/user")
+ @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
  public ResponseEntity<?> updateUser(@RequestBody UpdateAppClientDto user) {
 
  AppClient client = this.userService.findAppClientById(user.getId());
@@ -110,6 +113,7 @@ public ResponseEntity<?> updateUser(@RequestBody UpdateAppClientDto user) {
 
  }
  @PostMapping ("/notification")
+ @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
  public ResponseEntity<?> sendNotification(@RequestParam("email") String e) {
  UserEntity userByEmail = this.userService.findUserByEmail(e);
 
@@ -122,6 +126,7 @@ public ResponseEntity<?> sendNotification(@RequestParam("email") String e) {
  return new ResponseEntity<>(userByEmail, HttpStatus.OK);
  }
  @PostMapping("/password")
+ @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
  public ResponseEntity<?> setUpNewPassword(@RequestParam Long id, String password) {
  UserEntity userById = this.userService.findUserById(id);
  userById.setPassword(this.passwordEncoder.encode(password));
@@ -130,6 +135,7 @@ public ResponseEntity<?> setUpNewPassword(@RequestParam Long id, String passwor
  }
 
  @PutMapping("/business")
+ @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
  public ResponseEntity<?> updateBusiness(@RequestBody UpdateBusinessDto business) {
 
  BusinessOwner businessOwner = this.userService.findBusinessOwnerById(business.getId());
@@ -145,6 +151,7 @@ public ResponseEntity<?> updateBusiness(@RequestBody UpdateBusinessDto business
 
  }
  @DeleteMapping("/user/{id}")
+ @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
  public ResponseEntity<Long> deleteUser(@PathVariable Long id){
 
  boolean isRemoved = this.userService.deleteUser(id);
@@ -181,6 +188,7 @@ public JwtResponse authenticate(@RequestBody JwtRequest jwtRequest) throws Excep
 
  @PostMapping("/login")
  @CrossOrigin(origins = "http://localhost:4200")
+ @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
  public String logInUser(@RequestParam String username){
  UserEntity userByUsername = this.userService.findUserByUsername(username);
  if (userByUsername.getRoles().stream()

spring-backend/src/main/resources/META-INF/additional-spring-configuration-metadata.json

@@ -14,6 +14,11 @@
  "name": "jwt.secret",
  "type": "java.lang.String",
  "description": "Description for jwt.secret."
+ },
+ {
+ "name": "springdoc.swagger-ui.disable-swagger-default-url",
+ "type": "java.lang.String",
+ "description": "Description for springdoc.swagger-ui.disable-swagger-default-url."
  }
  ]
 }

spring-backend/src/main/resources/application.properties

@@ -17,12 +17,16 @@ spring.servlet.multipart.max-file-size=10MB
 spring.servlet.multipart.max-request-size=10MB
 spring.mail.host=smtp.gmail.com
 spring.mail.port=25
-spring.mail.username=findyourhobbie@gmail.com
-spring.mail.password=scejyiuhzjzqhezl
+spring.mail.username=*****
+spring.mail.password=*****
 spring.mail.protocol=smtp
 spring.mail.properties.mail.smtp.starttls.enable=true
 spring.mail.default-encoding=UTF-8
-#spring.security.user.name=user
-#spring.security.user.password=123
+springdoc.swagger-ui.use-root-path=true
+springdoc.swagger-ui.config-url=/v3/api-docs/swagger-config
+springdoc.swagger-ui.disable-swagger-default-url=true
+springdoc.swagger-ui.url=/v3/api-docs
+
+
 
 jwt.secret= secretly123