如何使用Swagger

最新推荐文章于 2024-05-15 11:48:04 发布

仰望星空的小乌龟

最新推荐文章于 2024-05-15 11:48:04 发布

阅读量141

点赞数

分类专栏： Swagger 文章标签： spring boot java 后端

本文链接：https://blog.csdn.net/weixin_46266624/article/details/130277107

版权

Swagger 专栏收录该内容

2 篇文章 0 订阅

订阅专栏

一、是什么？

这个解释简单点来讲就是说，swagger是一款可以根据resutful风格生成的生成的接口开发文档，

二、为什么要用？

1.不用再手写WiKi接口拼大量的参数，避免手写错误
2.后端只需要定义好接口，会自动生成文档，接口功能、参数一目了然
3.方法参数名修改、增加、减少参数都可以直接生效，不用手动维护

三、如何搭建

1.引入Swagger的依赖

一：引入Swagger依赖库
<!--引入swagger-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.7.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.7.0</version>
</dependency>

2.SpringBoot整合swagger

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket productApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))  //添加ApiOperiation注解的被扫描
                .paths(PathSelectors.any())
                .build();

    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title(”swagger和springBoot整合“).description(”swagger的API文档")
                .version("1.0").build();
    }

}