Spring boot集成Swagger

Spring boot集成Swagger

Pom文件添加依赖

 <!-- swagger依赖-->
        <dependency>
            <groupId>com.arpa</groupId>
            <artifactId>arpa-core</artifactId>
            <version>${arpa.version}</version>
            <exclusions>
                <exclusion>
                    <artifactId>swagger-annotations</artifactId>
                    <groupId>io.swagger</groupId>
                </exclusion>
                <exclusion>
                    <artifactId>hutool-all</artifactId>
                    <groupId>cn.hutool</groupId>
                </exclusion>
                <exclusion>
                    <artifactId>checker-qual</artifactId>
                    <groupId>org.checkerframework</groupId>
                </exclusion>
                <exclusion>
                    <artifactId>error_prone_annotations</artifactId>
                    <groupId>com.google.errorprone</groupId>
                </exclusion>
            </exclusions>
        </dependency>

编写swagger2文档

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
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;

/**
 * @description swagger2文档
 * @version 1.0
 * @create 2020/06/19 08:31
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig extends WebMvcConfigurationSupport {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
                .apis(RequestHandlerSelectors.basePackage("com.he.blog.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("学习MybatisPulsh")
                .description("我是小鸵鸟")
                .contact(new Contact("联系人", "www.baidu.com", "2214946614@qq.com"))
                .version("1.0").build();
    }

    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        // 解决静态资源无法访问
        registry.addResourceHandler("/**").addResourceLocations("classpath:/static/");
        // 解决swagger无法访问
        registry.addResourceHandler("/swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
        // 解决swagger的js文件无法访问
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}

作用范围	API	使用位置
对象属性	@ApiModelProperty	用在参数对象的字段上
协议集描述	@Api	用在Conntroller类上
协议描述	@ApiOperation	用在controller方法上
Response集	@ApiResponses	用在controller方法上
Response	@ApiResponse	用在@ApiResponses里面
非对象参数集	@ApilmplicitParams	用在controller方法上

非对象参数描述	@ApiImplicitParam	用在@ApiImplicitParams的方法里边
描述返回对象的意义	@ApiModel	用在返回对象类上

例：

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.he.blog.entity.User;
import com.he.blog.service.UserService;
import com.he.blog.utils.Result;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * <p>
 *  前端控制器
 * </p>
 *
 * @author 贺庆玉
 * @since 2021-03-02
 */
@Api(tags = "用户相关接口")  
@RestController
@RequestMapping("/blog/user")
public class UserController {

    @Autowired
    private UserService userService;

    @ApiOperation(value = "获取用户列表的接口",httpMethod ="GET")
    @GetMapping()
    public Result getUserList(){
        List<User> userList = userService.getUserList();
        return Result.ok(userList);
    }


    /**
     *
     * @param user
     * @return
     */
    @ApiOperation(value = "添加用户信息接口",httpMethod = "POST")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "name", value = "用户姓名", required = true, paramType = "query", dataType = "String", defaultValue = ""),
            @ApiImplicitParam(name = "age", value = "用户年龄", required = true, paramType = "query", dataType = "String", defaultValue = ""),
            @ApiImplicitParam(name = "email", value = "用户邮箱", required = true, paramType = "query", dataType = "String", defaultValue = ""),
            @ApiImplicitParam(name = "phone", value = "用户手机号", required = true, paramType = "query", dataType = "String", defaultValue = "")
    })
    @PostMapping()
    public Result save(User user){
        /*@Options(useGeneratedKeys=true, keyProperty="id", keyColumn="id")*/
        boolean save = userService.save(user);
        if (save == true){
            return Result.ok("添加成功");
        }
        return Result.ok("添加失败");
    }
}

默认访问地址：

Springboot工程格式

http://localhost:8080/swagger-ui.html

非Springboot工程格式（需加个项目名xxx）

http://localhost:8080/xxx/swagger-ui.html