使用Swagger2自动生成API文档-基于Spring Boot

1:添加俩依赖

<!--        Swagger自动生成API文档依赖-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

2:创建config.SpringFoxConfig.java,这个相当于一个模板,大家可以套用,当然一些自定义的可以自己更改根据自己的项目

@Configuration
public class SpringFoxConfig {

    //访问http://localhost:8080/swagger-ui.html可以看到API文档
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("生鲜")
                .description("")
                .termsOfServiceUrl("")
                .build();
    }
}

3:在Application添加注解@EnableSwagger2,也就是boot启动程序

4:创建config.AlphenMallWebMvcConfig.java用于配置地址映射,这是关键,我开始因为这里面的配置写错了,然后就无法访问

/*
* 配置地址映射
* */
@Configuration
public class AlphenMallWebMvcConfig implements WebMvcConfigurer {
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html").addResourceLocations(
                "classpath:/META-INF/resource/"
        );
        registry.addResourceHandler("/webjars/**").addResourceLocations(
                "classpath:/META-INF/resource/webjars/"
        );
    }
}

5:可以在Controller中的方法上加上注解@ApiOperation("定义")

6:打开Chrome输入http://localhost:8080/swagger-ui.html/

就可以了

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值