SpringBoot 配置 swagger2

1.添加依赖 

<!-- swagger2需要以下2个依赖  -->
<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>

 2.创建swagger2配置类，代码如下

package com.example.daimademo.common.configs;

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 buildDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(buildApiInf())
                .select()
                .apis(RequestHandlerSelectors
                .basePackage("com.example.daimademo"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo buildApiInf() {
        return new ApiInfoBuilder()
                .title("系统RESTful API文档")
                .contact(new Contact("jiguang", "http://www.baidu.com","11111111111@qq.com"))
                .version("1.0")
                .build();
    }

}

3.示例

package com.example.daimademo.testmap.controller;


import com.example.daimademo.common.entity.ResultCode;
import com.example.daimademo.common.entity.ResultInfo;
import com.example.daimademo.testmap.entity.CAdcd;
import com.example.daimademo.testmap.mapper.CAdcdMapper;
import com.example.daimademo.testmap.service.ICAdcdService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.*;

import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import java.util.List;
import java.util.Map;

/**
 * <p>
 *  前端控制器
 * </p>
 *
 * @author ssm
 * @since 2021-07-10
 */
@Slf4j
@RestController
@RequestMapping("/hhhh/cAdcd")
//@Api：用在类上，说明该类的作用。
@Api(value = "CAdcd管理")
public class CAdcdController {
    @Autowired
    private ICAdcdService iICAdcdService;

    @Autowired
    private CAdcdMapper cAdcdMapper;

    //@ApiOperation：注解来给API增加方法说明。
    @ApiOperation(value = "插入新数据", notes = "以json格式插入数据")
    //@ApiImplicitParams : 用在方法上包含一组参数说明。
    //@ApiImplicitParam：用来注解 方法入参 说明。
    @ApiImplicitParam(name = "entity", value = "json数据", required = true,dataType = "CAdcd", paramType = "body")
    @PostMapping("/save")
    public ResultInfo save(@RequestBody CAdcd entity){
        try {
            iICAdcdService.save(entity);
            return new ResultInfo<>(ResultCode.SUCCESS);
        } catch (Exception e) {
            e.printStackTrace();
            log.error(e.getMessage(),e);
            return new ResultInfo<>(ResultCode.FAIL,e.getCause().getMessage());
        }
    }

    @ApiOperation(value = "根据id删除记录",notes = "说明信息，注意事项")
    @ApiImplicitParams({
            @ApiImplicitParam(paramType="query", name = "id", value = "数据id", required = true, dataType = "Integer"),
            @ApiImplicitParam(paramType="query", name = "name", value = "名称", required = true, dataType = "String")
    })
    @PostMapping("/delById")
    public ResultInfo delById(@RequestBody CAdcd entity){
        try {
            iICAdcdService.removeById(entity);
            return new ResultInfo<>(ResultCode.SUCCESS);
        } catch (Exception e) {
            e.printStackTrace();
            log.error(e.getMessage(),e);
            return new ResultInfo<>(ResultCode.FAIL,e.getCause().getMessage());
        }
    }

   

    @ApiOperation(value = "测试返回map", notes = "根据用户id获取用户信息")
    @ApiImplicitParam(name = "id", value = "用户id", required = true,dataType = "string", paramType = "path")
    @GetMapping("/test")
    public ResultInfo test(){
        Map<Integer, CAdcd> map = cAdcdMapper.getMap();
        return new ResultInfo<>(ResultCode.SUCCESS,map);
    }
}

 完成上述代码添加上，启动Spring Boot程序，访问：http://localhost:8080/swagger-ui.html

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

=========================================================

Swagger使用的注解及其说明：

@Api：用在类上，说明该类的作用。

@ApiOperation：注解来给API增加方法说明。

@ApiImplicitParams : 用在方法上包含一组参数说明。

@ApiImplicitParam：用来给方法入参增加说明。

@ApiResponses：用于表示一组响应

@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息

    l   code：数字，例如400

    l   message：信息，例如"请求参数没填好"

    l   response：抛出异常的类   

@ApiModel：描述一个Model的信息（一般用在请求参数无法使用@ApiImplicitParam注解进行描述的时候）

    l   @ApiModelProperty：描述一个model的属性

注意：@ApiImplicitParam的参数说明：

paramType：指定参数放在哪个地方	header：请求参数放置于Request Header，使用@RequestHeader获取 query：请求参数放置于请求地址，使用@RequestParam获取 path：（用于restful接口）-->请求参数的获取：@PathVariable body：（不常用） form（不常用）
name：参数名
dataType：参数类型
required：参数是否必须传	true | false
value：说明参数的意思
defaultValue：参数的默认值