SpringBoot整合Swagger

SpringBoot整合Swagger

导入依赖

      <!--Swagger 框架-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>

        <!--Swagger UI-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>
    </dependencies>

首先通过 @EnableSwagger2 注解开启了 Swagger 2，然后最主要的是配置一个 Docket。

在程序入口添加注解

@SpringBootApplication
@EnableSwagger2
public class IocasApplication {
     

    public static void main(String[] args) {
     
        SpringApplication.run(IocasApplication.class, args);
    }

}

通过 apis 方法配置要扫描的 controller 位置，通过 paths 方法配置路径。
在 apiInfo 中构建文档的基本信息，例如描述、联系人信息、版本、标题等。

在接口控制类添加注解

1、@Api 注解标注在类上用来描述整个 Controller 信息。
2、@ApiOperation 注解标注在方法上，用来描述一个方法的基本信息。
3、@ApiImplicitParam 注解标注在方法上，用来描述方法的参数。其中paramType 是指方法参数的类型，有如下可选值：
path：参数获取方式为 @PathVariable
query：参数获取方式为 @RequestParam
header：参数获取方式为 @RequestHeader
body
form
如果有多个参数，可以将多个参数的 @ApiImplicitParam 注解放到 @ApiImplicitParams 中。
@ApiResponse 是对响应结果的描述。code 表示响应码，message 为相应的描述信息。如果有多个@ApiResponse，则放在一个 @ApiResponses 中。
@ApiIgnore 注解表示不对某个接口生成文档。

@Api(tags = "用户api详情")
@RestController
@CrossOrigin(origins = "*",maxAge = 3600)
@ResponseBody

public class UserController {
     
    @Autowired
    private UserMapper userMapper;

    @ApiOperation(value = "用户查询",notes = "获取所有的用户")
    @GetMapping("/getdata")
    public User getData() {
     
        User user = userMapper.queryUserList();
        System.out.println(user);
        return user;
    }
}

访问http://localhost:6060/swagger-ui.html

注 6060是自己程序的端口。