Spring Boot 2.x使用swagger2.8.0生成在线API文档

刺骨的言语ヽ痛彻心扉 2022-05-20 10:40 138阅读 0赞

### 1，在pom文件里面添加swagger的依赖和ui依赖 ###

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>com.itpengwei.ideaboot</groupId>
        <artifactId>swagger-demo</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <packaging>jar</packaging>
    
        <name>swagger-demo</name>
        <description>Demo project for Spring Boot</description>
    
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.0.3.RELEASE</version>
            <relativePath/> 
        </parent>
    
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger2</artifactId>
                <version>2.8.0</version>
            </dependency>
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger-ui</artifactId>
                <version>2.8.0</version>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    
    </project>

### 2，创建配置类 ###

package com.itpengwei.config;
    
    import io.swagger.annotations.ApiOperation;
    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.service.Contact;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    import springfox.documentation.swagger2.annotations.EnableSwagger2;
    
    @Configuration
    @EnableSwagger2
    public class SwaggerConfig {
    //    @Bean
        public Docket swaggerSpringMvcPlugin() {
            return new Docket(DocumentationType.SWAGGER_2).select().
                    apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)).build();
        }
    
        @Bean
        public Docket api() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    // 自行修改为自己的包路径
                    .apis(RequestHandlerSelectors.basePackage("com.itpengwei.controller"))
                    .paths(PathSelectors.any())
                    .build();
        }
    
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
                    .title("api文档")
                    .description("restFUL 风格接口")
                    .version("1.0")
                    .build();
        }
    }

### 3,创建Controller ###

package com.itpengwei.controller;
    
    import com.itpengwei.model.User;
    import io.swagger.annotations.Api;
    import io.swagger.annotations.ApiImplicitParam;
    import io.swagger.annotations.ApiOperation;
    import org.springframework.web.bind.annotation.*;
    
    import java.util.ArrayList;
    import java.util.List;
    
    @Api(value = "/user", tags = "用户模块")
    @RestController
    @RequestMapping("/user")
    public class UserController {
        @ApiOperation(value = "展示用户信息",notes = "展示用户")
        @GetMapping("/userList")
        public List<User> getUserlist() {
            List<User> users = new ArrayList<>();
            for (int i = 0; i < 10; i++) {
                User user = new User();
                user.setSex("男");
                user.setAge(i);
                user.setUsername("test" + i);
                users.add(user);
            }
            return users;
        }
        @ApiOperation(value = "用户添加",notes = "添加用户")
        @ApiImplicitParam(name = "user",value = "User",required = true,dataType ="User")
        @PostMapping(value = "/addUser")
        public String addUser(User user){
            return "添加成功";
        }
        @ApiOperation(value = "删除用户",notes = "删除用户")
        @ApiImplicitParam(name = "id",value = "id",required = true,dataType = "Integer")
        @DeleteMapping("/deleteById/{id}")
        public String deleteById(@PathVariable("id")Integer id){
            return "删除成功";
        }
        @ApiOperation(value = "修改用户",notes = "修改用户")
        @PutMapping("/updateUser")
        @ApiImplicitParam(name = "user",value = "User",required = true,dataType = "User")
        public String updateUser(User user){
            return "修改成功";
        }
    }

### 4，创建启动类 ###

package com.itpengwei;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    public class SwaggerDemoApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(SwaggerDemoApplication.class, args);
        }
    }

### 5,启动，效果图如下 ###

![70][]

[70]: /images/20220520/ea4116ca39794db3a46fe3993a0200bd.png