使用Knife4j美化Swagger

一时失言乱红尘 2022-12-15 03:24 321阅读 0赞

**使用Knife4j美化Swagger**

*  **依赖：**

<dependencies>
    	<dependency>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-web</artifactId>
    	</dependency>
    	<dependency>
    		<groupId>io.springfox</groupId>
    		<artifactId>springfox-swagger-ui</artifactId>
    		<version>2.7.0</version>
    	</dependency>
    	<dependency>
    		<groupId>io.springfox</groupId>
    		<artifactId>springfox-swagger2</artifactId>
    		<version>2.7.0</version>
    	</dependency>
    	<dependency>
    		<groupId>com.github.xiaoymin</groupId>
    		<artifactId>knife4j-spring-boot-starter</artifactId>
    		<version>2.0.4</version>
    	</dependency>
    	<dependency>
    		<groupId>org.projectlombok</groupId>
    		<artifactId>lombok</artifactId>
    		<optional>true</optional>
    	</dependency>
    	<dependency>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-test</artifactId>
    		<scope>test</scope>
    		<exclusions>
    			<exclusion>
    				<groupId>org.junit.vintage</groupId>
    				<artifactId>junit-vintage-engine</artifactId>
    			</exclusion>
    		</exclusions>
    	</dependency>
    </dependencies>

*  **SwaggerConfiguration**

package com.blu.config;
    
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    
    import springfox.documentation.builders.ApiInfoBuilder;
    import springfox.documentation.builders.PathSelectors;
    import springfox.documentation.builders.RequestHandlerSelectors;
    import springfox.documentation.service.ApiInfo;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    import springfox.documentation.swagger2.annotations.EnableSwagger2;
    
    @Configuration
    @EnableSwagger2
    public class SwaggerConfiguration { 
    	
    	@Bean
        public Docket createRestApi() { 
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("com.blu.controller"))
                    .paths(PathSelectors.any())
                    .build();
        }
    
        private ApiInfo apiInfo() { 
            return new ApiInfoBuilder()
                    .title("项目 APIs")
                    .description("API文档 by BLU")
                    .termsOfServiceUrl("http://118.31.106.51/")
                    .contact("2711978737@qq.com")
                    .version("1.0")
                    .build();
        }
    
    }

*  **User实体类**

package com.blu.entity;
    
    import io.swagger.annotations.ApiModelProperty;
    import lombok.Data;
    
    @Data
    public class User { 
    
    	@ApiModelProperty("用户ID")
    	private int id;
    	@ApiModelProperty("用户名")
    	private String username;
    	@ApiModelProperty("年龄")
    	private int age;
    	
    }

*  **HelloController**

package com.blu.controller;
    
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.PostMapping;
    import org.springframework.web.bind.annotation.RequestParam;
    import org.springframework.web.bind.annotation.RestController;
    
    import com.blu.entity.User;
    
    import io.swagger.annotations.Api;
    import io.swagger.annotations.ApiOperation;
    import io.swagger.annotations.ApiParam;
    
    @Api(value="HelloController",tags="HelloController控制类")
    @RestController
    public class HelloController { 
    
    	@ApiOperation("HelloController控制类中的Hello()方法")
    	@GetMapping(value="/hello")
    	public String Hello() { 
    		return "hello";
    	}
    	
    	@ApiOperation("HelloController控制类中的user()方法")
    	@PostMapping("/user")
    	public User user() { 
    		return new User();
    	}
    	
    	@ApiOperation("HelloController控制类中的Hello2()方法")
    	@GetMapping("/hello2")
    	public String Hello2(@ApiParam("Hello2()方法中的username参数") @RequestParam String username) { 
    		return "hello"+username;
    	}
    	
    }

**启动后，访问：[http://localhost:8080/swagger-ui.html][http_localhost_8080_swagger-ui.html]**

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JMVV8xMTE_size_16_color_FFFFFF_t_70_pic_center]  
**访问：[http://localhost:8080/doc.html][http_localhost_8080_doc.html]**

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JMVV8xMTE_size_16_color_FFFFFF_t_70_pic_center 1]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JMVV8xMTE_size_16_color_FFFFFF_t_70_pic_center 2]

[http_localhost_8080_swagger-ui.html]: http://localhost:8080/swagger-ui.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JMVV8xMTE_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/31f5f7443ae24ba9b418986e6bd1bbf5.png
[http_localhost_8080_doc.html]: http://localhost:8080/doc.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JMVV8xMTE_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221123/2ebd19f966804715a107c33d2a7b331f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JMVV8xMTE_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221123/2fa55232b4c6468a8101549e3e77199a.png