SpringBoot整合swagger2

一、先在工程pom下添加如下依赖：

        <!-- swagger2 配置 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.4.0</version>
        </dependency>

       <!-- ui界面可二选一 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.4.0</version>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.6</version>
        </dependency>

       <!-- 有时候项目启动会报找不到guava的一些类 -->
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>20.0</version>
        </dependency>

 

二、然后配置swagger，代码如下：

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 Swagger2 {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)  // 指定api类型为swagger2
                    .apiInfo(apiInfo())                 // 用于定义api文档汇总信息
                    .select()
                    .apis(RequestHandlerSelectors
                            .basePackage("com.newmall.controller"))   // 指定controller包
                    .paths(PathSelectors.any())         // 所有controller
                    .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("api")        // 文档页标题
                .contact(new Contact("newmall",
                        "https://www.newmall.com",
                        "abc@newmall.com"))        // 联系人信息
                .description("newmall的api文档")  // 详细信息
                .version("1.0.1")   // 文档版本号
                .termsOfServiceUrl("https://www.newmall.com") // 网站地址
                .build();
    }

}

在Controller层加如下注解：

import com.newmall.pojo.bo.UserBO;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@Api(value = "注册登录", tags = {"用于注册登录的相关接口"})
@RestController
@RequestMapping("passport")
public class TestController {

    @ApiOperation(value = "用户注册", notes = "用户注册", httpMethod = "POST")
    @PostMapping("/regist")
    public JsonResult regist(@RequestBody UserBO userBO) {

    }  


}

@Api用于类，表示标识这个类是swagger的资源，其中value - 字段说明，description - 注释说明这个类

@ApiOperation 用于方法上，其中value - 字段说明，notes - 注释说明，httpMethod - 说明这个方法被请求的方式，response - 方法的返回值的类型

在Bean上可以加如下注解：

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

@ApiModel(value = "用户对象BO", description = "用户数据对象")
public class UserBO {

    @ApiModelProperty(value = "用户名", name = "username", example = "newmall", required = true)
    private String username;

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

}

@ApiModel表示对类进行说明，用于参数用实体类接收，其中value - 字段说明，description - 注释说明这个类

@ApiModelProperty用于方法/字段表示对model属性的说明。

三、配置完后，启动项目，本地访问项目自己的端口号：

其中，依赖中springfox-swagger-ui的访问路径:

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

swagger-bootstrap-ui访问路径:

http://localhost:8080/doc.html

可以只选择一个依赖。

 

四、还有一些其他注解，具体可参考官网的详细说明:

https://github.com/swagger-api/swagger-core/wiki/Annotations-1.5.X#quick-annotation-overview