springboot项目整合swagger2

springboot项目整合swagger2

什么是 Swagger

Swagger 2 是一个开源软件框架，可以帮助开发人员设计、构建、记录和使用 RESTful Web 服务，它将代码和文档融为一体，可以完美解决文档编写繁琐、维护不方便等问题。使得开发人员可以将大部分精力集中到业务中，而不是繁杂琐碎的文档中。

由于现在都是前后端分离，前端和后端对接的桥梁就是一份详细且一目了然的api文档，但是手写api文档是很费时间且很痛苦的，如今出现了像swagger2这样的自动生成api文档的神器，使用起来也很简单，生成的api文档也很详细，一幕了然，做后端开发都应该学会使用这个神器

要使用swagger2，首先要导入相关依赖

<!--Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。-->
<!--这个依赖是swagger2官方的是必须加的，它包含了一系列用来标注在类上和方法上并进行说明的注解-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.7.0</version>
</dependency>
<!--这个swagger-ui是官方提供的一个前端页面，用来查看并导出生成的api文档-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.7.0</version>
</dependency>

然后编写一个启动swagger2的类，并且把下面apis(RequestHandlerSelectors.basePackage(“com.usethymeleaf.controller”))的basePackage改成自己的控制层全路径

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 Swagger {
    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.usethymeleaf.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    public ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("利用swagger2构建的API文档")
                .description("用restful风格写接口")
                .termsOfServiceUrl("")
                .version("1.0")
                .build();
    }
}

编写一个控制器做测试

import com.usethymeleaf.entity.SmbmsUser;
import com.usethymeleaf.service.SmbmsUserService;
import io.swagger.annotations.*;
import org.springframework.web.bind.annotation.*;

import javax.annotation.Resource;
import javax.servlet.http.HttpSession;

@RestController
@RequestMapping("/smbmsUser")
@Api(tags = "用户登录注册注销类")
public class SmbmsUserController {
    /**
     * 服务对象
     */
    @Resource
    private SmbmsUserService smbmsUserService;

    @PostMapping("/login")
    @ApiOperation(value = "登录接口", notes = "登录成功返回index，否则返回false")
    @ApiImplicitParams({
            @ApiImplicitParam(paramType = "query", name = "username", value = "用户名", required = true),
            @ApiImplicitParam(paramType = "query", name = "password", value = "密码", required = true)})
    public String login(@RequestParam("username") String username, @RequestParam("password") String password, HttpSession session) {
        SmbmsUser login = smbmsUserService.login(username, password);
        if (login != null) {
            session.setAttribute("user", login);
        } else {
            System.out.println("账号或者密码错误！");
        }
        return login == null ? "login" : "index";
    }

    /**
     *获取session里的用户信息
     * @param session session对象
     * @return 任何类型
     */
    @PostMapping("/getSession")
    @ApiOperation(value = "获取session中的用户信息", notes = "返回登录后存在session里的用户信息")
    @ApiImplicitParam(paramType = "query", name = "session", value = "session对象", required = false)
    public Object getSession(HttpSession session) {
        return session.getAttribute("user");
    }

    @PostMapping("/loginOut")
    @ApiOperation(value = "销毁session会话", notes = "销毁session会话")
    @ApiImplicitParam(paramType = "query", name = "session", value = "session对象", required = false)
    public void loginOut(HttpSession session) {
        session.invalidate();
    }
}

启动项目，浏览器访问http://localhost:端口/swagger-ui.html

这样就实现了一个springboot项目的简单api文档的自动生成。

Swagger2注解的使用

@Api：用在请求的类上，表示对类的说明
    tags="说明该类的作用，可以在UI界面上看到的注解"
    value="该参数没什么意义，在UI界面上也看到，所以不需要配置"

@ApiOperation：用在请求的方法上，说明方法的用途、作用
    value="说明方法的用途、作用"
    notes="方法的备注说明"

@ApiImplicitParams：用在请求的方法上，表示一组参数说明
    @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
        name：参数名
        value：参数的汉字说明、解释
        required：参数是否必须传
        paramType：参数放在哪个地方
            · header --> 请求参数的获取：@RequestHeader
            · query --> 请求参数的获取：@RequestParam
            · path（用于restful接口）--> 请求参数的获取：@PathVariable
            · body（不常用）
            · form（不常用）    
        dataType：参数类型，默认String，其它值dataType="Integer"       
        defaultValue：参数的默认值

@ApiResponses：用在请求的方法上，表示一组响应
    @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
        code：数字，例如400
        message：信息，例如"请求参数没填好"
        response：抛出异常的类

@ApiModel：用于响应类上，表示一个返回响应数据的信息
            （这种一般用在post创建的时候，使用@RequestBody这样的场景，
            请求参数无法使用@ApiImplicitParam注解进行描述的时候）
    @ApiModelProperty：用在属性上，描述响应类的属性