Swagger Api documentation is done successfully.

Author: manirDev

pom.xml

@@ -64,6 +64,12 @@
 			<artifactId>jjwt</artifactId>
 			<version>0.9.1</version>
 		</dependency>
+		<!-- https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter -->
+		<dependency>
+			<groupId>io.springfox</groupId>
+			<artifactId>springfox-boot-starter</artifactId>
+			<version>3.0.0</version>
+		</dependency>
 
 		<dependency>
 			<groupId>org.springframework.boot</groupId>

src/main/java/com/springboot/blog/rest/api/config/SecurityConfig.java

@@ -49,6 +49,12 @@ protected void configure(HttpSecurity http) throws Exception {
                 .authorizeRequests()
                 .antMatchers(HttpMethod.GET, "/api/posts/**").permitAll()
                 .antMatchers( "/api/auth/**").permitAll()
+                //swagger link
+                .antMatchers("/v2/api-docs/**").permitAll()
+                .antMatchers("/swagger-ui/**").permitAll()
+                .antMatchers("/swagger-resources/**").permitAll()
+                .antMatchers("/swagger-ui.html").permitAll()
+                .antMatchers("/webjars/**").permitAll()
                 .anyRequest()
                 .authenticated();
                 //Basic auth

src/main/java/com/springboot/blog/rest/api/config/SwaggerConfig.java

@@ -0,0 +1,63 @@
+package com.springboot.blog.rest.api.config;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import springfox.documentation.RequestHandler;
+import springfox.documentation.builders.PathSelectors;
+import springfox.documentation.builders.RequestHandlerSelectors;
+import springfox.documentation.service.*;
+import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spi.service.contexts.SecurityContext;
+import springfox.documentation.spring.web.plugins.Docket;
+
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+
+@Configuration
+public class SwaggerConfig {
+    public static final String AUTHORIZATION_HEADER = "Authorization";
+
+    private ApiKey apiKey(){
+        return new ApiKey("JWT", AUTHORIZATION_HEADER, "header");
+    }
+    private ApiInfo apiInfo(){
+        return new ApiInfo(
+                "Spring Boot Blog Rest Api",
+                "Spring Boot Blog Rest Api Documentation",
+                "1",
+                "Terms of service",
+                new Contact("Mahamat Nour","www.github.com/manirDev", "[email protected]"),
+                "Licence of the API",
+                "Api licence Url",
+                Collections.emptyList()
+        );
+    }
+
+    @Bean
+    public Docket api(){
+        return new Docket(DocumentationType.SWAGGER_2)
+                .apiInfo(apiInfo())
+                //enable jwt
+                .securityContexts(Arrays.asList(securityContext()))
+                .securitySchemes(Arrays.asList(apiKey()))
+                //----------------------------
+                .select()
+                .apis(RequestHandlerSelectors.any())
+                .paths(PathSelectors.any())
+                .build();
+    }
+
+    private SecurityContext securityContext(){
+        return SecurityContext.builder().securityReferences(defaultAuth()).build();
+    }
+
+    private List<SecurityReference> defaultAuth(){
+        AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
+        AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
+        authorizationScopes[0] = authorizationScope;
+
+        return Arrays.asList(new SecurityReference("JWt", authorizationScopes));
+    }
+
+}

src/main/java/com/springboot/blog/rest/api/controller/AuthController.java

@@ -9,6 +9,8 @@
 import com.springboot.blog.rest.api.repository.UserRepository;
 import com.springboot.blog.rest.api.security.JwtTokenProvider;
 import com.springboot.blog.rest.api.service.UserRegisterService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
@@ -21,6 +23,7 @@
 
 import java.util.Collections;
 
+@Api(value = "Auth Controller provide signIn and signUp Rest APIs")
 @RestController
 @RequestMapping(path = "api/auth")
 public class AuthController {
@@ -33,6 +36,8 @@ public class AuthController {
     private UserRegisterService userRegisterService;
     @Autowired
     private JwtTokenProvider jwtTokenProvider;
+
+    @ApiOperation(value = "Rest API for User register to the Blog app")
     @PostMapping("/signIn")
     public ResponseEntity<JwtAuthResponse> authenticator(@RequestBody LoginDto loginDto){
          Authentication authentication = authenticationManager.authenticate(new UsernamePasswordAuthenticationToken(
@@ -47,6 +52,7 @@ public ResponseEntity<JwtAuthResponse> authenticator(@RequestBody LoginDto login
         return ResponseEntity.ok(new JwtAuthResponse(token));
     }
 
+    @ApiOperation(value = "Rest API for User login to the Blog app")
     @PostMapping("/signUp")
     public ResponseEntity<?> registerUser(@RequestBody SignUpDto signUpDto){
         //check if email or username exist

src/main/java/com/springboot/blog/rest/api/controller/CommentController.java

@@ -2,6 +2,8 @@
 
 import com.springboot.blog.rest.api.dto.CommentDto;
 import com.springboot.blog.rest.api.service.CommentService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.*;
@@ -10,6 +12,7 @@
 import java.security.PublicKey;
 import java.util.List;
 
+@Api(value = "CRUD rest API for Comment resource")
 @RestController
 @RequestMapping("api/posts")
 public class CommentController {
@@ -19,19 +22,22 @@ public CommentController(CommentService commentService) {
     }
 
     //create comment for post api
+    @ApiOperation(value = "Rest API for creating  a comment")
     @PostMapping("/{postId}/comments")
     public ResponseEntity<CommentDto> createComment(@Valid @RequestBody CommentDto commentDto,
                                                     @PathVariable Long postId){
         return new ResponseEntity<>(commentService.createComment(commentDto, postId), HttpStatus.CREATED);
     }
 
     //get comments by post id api
+    @ApiOperation(value = "Rest API for getting  all comments")
     @GetMapping("/{postId}/getComments")
     public List<CommentDto> getAllCommentsByPostId(@PathVariable Long postId){
         return commentService.getAllCommentsByPostId(postId);
     }
 
     //get comment by post id and comment id
+    @ApiOperation(value = "Rest API for getting  a comment by id")
     @GetMapping("/{postId}/comment/{commentId}")
     public ResponseEntity<CommentDto> getCommentById(@PathVariable Long postId,
                                                      @PathVariable Long commentId){
@@ -41,6 +47,7 @@ public ResponseEntity<CommentDto> getCommentById(@PathVariable Long postId,
     }
 
     //update comment
+    @ApiOperation(value = "Rest API for updating  a comment")
     @PutMapping("/{postId}/updateComment/{commentId}")
     public ResponseEntity<CommentDto> updateComment(@PathVariable Long postId,
                                                     @Valid @RequestBody CommentDto commentDto,
@@ -50,6 +57,7 @@ public ResponseEntity<CommentDto> updateComment(@PathVariable Long postId,
     }
 
     //delete comment
+    @ApiOperation(value = "Rest API for deleting  a comment")
     @DeleteMapping("/{postId}/deleteComment/{commentId}")
     public ResponseEntity<String> deleteComment(@PathVariable Long postId,
                                                 @PathVariable Long commentId){

src/main/java/com/springboot/blog/rest/api/controller/PostController.java

@@ -4,14 +4,17 @@
 import com.springboot.blog.rest.api.dto.PostResponse;
 import com.springboot.blog.rest.api.service.PostService;
 import com.springboot.blog.rest.api.utils.Constant;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiResponse;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.web.bind.annotation.*;
 
 import javax.validation.Valid;
 
-
+@Api(value = "CRUD rest API for Post resource")
 @RestController
 @RequestMapping(path = "api/posts")
 public class PostController {
@@ -23,6 +26,7 @@ public PostController(PostService postService) {
     }
 
     //add post api
+    @ApiOperation(value = "Rest API for creating a post")
     @PreAuthorize("hasRole('ADMIN')")
     @PostMapping("/createPost")
     public ResponseEntity<PostDto> createPost(@Valid @RequestBody PostDto postDto){
@@ -33,6 +37,7 @@ public ResponseEntity<PostDto> createPost(@Valid @RequestBody PostDto postDto){
     }
 
     //get all posts api
+    @ApiOperation(value = "Rest API for getting all posts")
     @GetMapping("/allPosts")
     public PostResponse getAllPosts(
             @RequestParam(value ="pageNo", defaultValue = Constant.DEFAULT_PAGE_NUMBER, required = false) int pageNo,
@@ -44,12 +49,14 @@ public PostResponse getAllPosts(
     }
 
     //get post by id api
+    @ApiOperation(value = "Rest API for getting a post by postId")
     @GetMapping("/getPost/{postId}")
     public ResponseEntity<PostDto> getPostById(@PathVariable Long postId){
         return  ResponseEntity.ok(postService.getPostById(postId));
     }
 
     //update post api
+    @ApiOperation(value = "Rest API for updating a post")
     @PreAuthorize("hasRole('ADMIN')")
     @PutMapping("/update/{postId}")
     public ResponseEntity<PostDto> updatePost(@Valid @RequestBody PostDto postDto, @PathVariable Long postId){
@@ -58,6 +65,7 @@ public ResponseEntity<PostDto> updatePost(@Valid @RequestBody PostDto postDto, @
     }
 
     //delete post api
+    @ApiOperation(value = "Rest API for deleting a post")
     @PreAuthorize("hasRole('ADMIN')")
     @DeleteMapping("/delete/{postId}")
     public ResponseEntity<String> deletePost(@PathVariable Long postId){

src/main/java/com/springboot/blog/rest/api/dto/CommentDto.java

@@ -1,19 +1,26 @@
 package com.springboot.blog.rest.api.dto;
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import javax.validation.constraints.Email;
 import javax.validation.constraints.NotEmpty;
 import javax.validation.constraints.Size;
 
+@ApiModel(value = "Comment resource information")
 @Data
 public class CommentDto {
+    @ApiModelProperty(value = "Blog comment id")
     private Long id;
+    @ApiModelProperty(value = "Blog comment name")
     @NotEmpty(message = "Name should not be empty or null")
     private String name;
+    @ApiModelProperty(value = "Blog comment email")
     @NotEmpty(message = "Email should not be empty or null")
     @Email
     private String email;
+    @ApiModelProperty(value = "Blog comment body")
     @NotEmpty
     @Size(min = 5, message = "Body should be at least 5 characters")
     private String body;

src/main/java/com/springboot/blog/rest/api/dto/PostDto.java

@@ -1,22 +1,30 @@
 package com.springboot.blog.rest.api.dto;
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import javax.validation.constraints.NotEmpty;
 import javax.validation.constraints.Size;
 import java.util.Set;
 
+@ApiModel(description = "Post resource information")
 @Data
 public class PostDto {
 
+    @ApiModelProperty(value = "Blog post id")
     private Long id;
+    @ApiModelProperty(value = "Blog post title")
     @NotEmpty
     @Size(min = 2, message = "Post title should have at least 2 characters")
     private String title;
+    @ApiModelProperty(value = "Blog post description")
     @NotEmpty
     @Size(min = 5, message = "Post description should have at least 2 characters")
     private String description;
+    @ApiModelProperty(value = "Blog post content")
     @NotEmpty
     private String content;
+    @ApiModelProperty(value = "Blog post comments")
     private Set<CommentDto> comments;
 }

src/main/resources/application.properties

@@ -13,3 +13,6 @@ logging.level.org.springframework.security=DEBUG
 app.jwt-secret = JWTSecretKey
 app.jwt-expiration-milliseconds = 604800000
 
+#Swagger enabling
+spring.mvc.pathmatch.matching-strategy = ANT_PATH_MATCHER
+