Springboot 整合Swagger

1. 父pom 整合

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

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

2.Swagger配置类

注意修改 basePackage 包 即 controller 的位置：com.leyu.chat.controller

@Configuration
public class Swagger2 {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.leyu.chat.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("springboot利用swagger构建api文档")
                .description("简单优雅的restfun风格，http://blog.csdn.net/saytime")
                .termsOfServiceUrl("http://blog.csdn.net/saytime")
                .version("1.0")
                .build();
    }
}

3.Springboot 启动类添加

添加 ：

@EnableSwagger2

@SpringBootApplication
@MapperScan("com.leyu.chat.dao")
@EnableSwagger2
public class ChatApp {

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

4.接口注释

@RequestBody 表示需要User 这个对象，不能为null，里面局部字段可以为null

@RequestParam 表示这个值不能为null

Swagger 界面也会提示需要参数，不然try out 无法执行

@ApiOperation("新增一个user用户")
    @PostMapping("/iUser")
    public Object insert(@RequestBody User user){
        //插入数据 ，报异常 则失败，不用判断insert i=1;
        userMapper.insert(user);
        return new HashMap();
    }
    @ApiOperation("删除一个user用户")
    @PostMapping("/dUser")
    public Object delete(@RequestParam Long id){
        userMapper.delete(id);
        return new HashMap();
    }

5. 访问 ：http://localhost:8888/swagger-ui.html