spring boot 中使用swagger

Posted 2020-12-05 tmsdxcz

一、pom.xml

<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>

二、创建Swagger2类

@Configuration
@EnableSwagger2
public class Swagger2 {
    @Bean
    public Docket createRestApi() {
        List<Parameter> pars = new ArrayList<Parameter>();
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
                .paths(PathSelectors.any())
                .build()
                .globalOperationParameters(pars)
                .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("小王 RESTful API")
                .description("使用swagger2结合写api")
                .termsOfServiceUrl("https://www.cnblogs.com/")
                .version("1.0")
                .build();
    }
}

三、启动位置配置

@SpringBootApplication
@EnableSwagger2
public class SmlzApplication {

    public static void main(String[] args) {
        SpringApplication.run(SmlzApplication.class, args);
    }
}
四、使用

@PostMapping("/save-book")
@ApiOperation(value = "添加书籍",notes = "暂时没连接数据库")
public Book saveBook(@RequestBody Book book){
    return bookSerivce.insertByBook(book);
}