swagger2的集成

1、添加依赖

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>

<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.9.6</version>
</dependency>

2、添加swagger配置类

package com.qianli.fmmall.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.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 {
    /*
        swagger会帮助我们生成接口文档
        1、配置生成的接口文档信息---接口文档的封面信息：标题，描述，版本，作者
        2、配置swagger注解寻找规则---哪个包，哪个路径
     */

    /*Docket封装接口文档信息*/
    @Bean
    public Docket getDocket(){
        // 创建封面信息对象
        ApiInfoBuilder apiInfoBuilder = new ApiInfoBuilder();
        apiInfoBuilder.title("<<xxx项目>>后端接口说明")
                .description("此文档详细说明了项目中接口使用规范...")
                .version("V 1.0.1")
                .contact(new Contact("你大爷", "https://www.baidu.com", "nidaye@qq.com"));
        ApiInfo apiInfo = apiInfoBuilder.build();

        Docket docket = new Docket(DocumentationType.SWAGGER_2)//指定文档风格
                .apiInfo(apiInfo) // 指定接口文档的封面信息：标题，描述，版本，作者
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.qianli.fmmall.controller")) //指定控制器所在包
                //.paths(PathSelectors.regex("/user/")) //指定具体请求映射路径
                .paths(PathSelectors.any()) //指定所有请求映射路径
                .build();
        return docket;
    }
}

3、对控制器类、对控制器类中的请求映射方法、对控制器类中的请求映射方法的对象参数所属类、对响应对象所属类

package com.qianli.fmmall.controller;

import com.qianli.fmmall.common.ResultVo;
import com.qianli.fmmall.entities.User;
import com.qianli.fmmall.service.UserService;
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.stereotype.Controller;
import org.springframework.web.bind.annotation.*;

@Controller
@ResponseBody
@RequestMapping("/user")
@Api(value = "提供用户注册、登录的接口使用说明", tags = "用户管理")
public class UserController {

    @Autowired
    UserService userService;

    @RequestMapping(value = "/login", method = RequestMethod.GET)
    @ApiOperation("用户登录接口 ")
    @ApiImplicitParams({
            @ApiImplicitParam(dataType = "String", name = "name", value = "用户名", required = true),
            @ApiImplicitParam(dataType = "String", name = "ad", value = "地址", defaultValue = "sh", required = false)
    })
    public ResultVo login(String name, @RequestParam(value = "ad", defaultValue = "sh") String address){
        return userService.login(new User(name, address));
    }

    @RequestMapping(value = "/register", method = RequestMethod.POST)
    @ApiOperation("用户注册接口")
    // @ApiImplicitParam(name = "user",  required = true)
    public ResultVo register(@RequestBody User user){
        System.out.println("注册");
        return  new ResultVo(200, "注册成功", user );
    }
}

//http://localhost:8899/nidaye/swagger-ui.html
//http://localhost:8899/nidaye/doc.html

package com.qianli.fmmall.controller;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
@ResponseBody
@Api(value = "提供商品的查询、修改、删除、添加接口说明", tags = "商品管理")
public class GoodsController {

    @RequestMapping(value = "/query", method = RequestMethod.GET)
    @ApiOperation("查询商品")
    @ApiImplicitParam(dataType = "int", name = "goodId", value = "商品id", required = true)
    public void queryGoods(int goodId){

    }

    @RequestMapping(value = "/update", method = RequestMethod.POST)
    @ApiOperation("修改商品")
    @ApiImplicitParam(dataType = "int", name = "goodId", value = "商品id", required = true)
    public void updateGood(int goodId){

    }

    @RequestMapping(value = "/delete", method = RequestMethod.POST)
    @ApiOperation("删除商品")
    @ApiImplicitParam(dataType = "int", name = "goodId", value = "商品id", required = true)
    public void deleteGood(int goodId){

    }

    @RequestMapping(value = "/add", method = RequestMethod.POST)
    @ApiOperation("添加商品")
    public void addGood(){

    }
}

package com.qianli.fmmall.entities;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@NoArgsConstructor
@AllArgsConstructor
@ApiModel(value = "User对象", description = "用户信息")
public class User {
    @ApiModelProperty(dataType = "String", value = "用户名", required = true)
    private String name;
    @ApiModelProperty(dataType = "String", value = "用户地址", required = true)
    private String address;
}

package com.qianli.fmmall.common;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@NoArgsConstructor
@AllArgsConstructor
@ApiModel(value = "ResultVo对象", description = "接口返回的数据类型")
public class ResultVo {
    @ApiModelProperty(value = "响应状态码", dataType = "int")
    private int code;
    @ApiModelProperty(value = "响应消息", dataType = "String")
    private String msg;
    @ApiModelProperty(value = "响应数据" )
    private Object data;
}