spring boot 实现swagger配置

其实spring boot 实现swagger的配置其实很简单,启动类加上注解@EnableSwagger2  controller类及方法上加上相应注解,启动即可实现 如:

本博客稍微改动了下,做了一些小配置省去了controller类上加注解的麻烦

导入swagger依赖

<!--swagger依赖-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.7.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.7.0</version>
</dependency>

1,编写配置类SwaggerConfig

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestapi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //扫描包(需要扫描api的包)
                .apis(RequestHandlerSelectors.basePackage("com.example.demoswagger.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    //swagger显示页面的一些基本信息
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("这个我的swagger")
                .description("swagger2")
                .termsOfServiceUrl("")
                .version("1.0")
                .build();
    }
}

2,编写跳转到swagger-ui.html的api       注意加上@ApiIgnore注解,忽略扫描Swaggerapi类

@ApiIgnore
@Controller
public class Swaggerapi {

    @RequestMapping("/api")
    public String redirectSwagger() {
        //重定向到swagger页面
        return "redirect:swagger-ui.html";
    }
}

3,编写controller api方法   随便写了一个

@RestController
@RequestMapping("orders")
public class CeShiapi {

    Logger logger = LoggerFactory.getLogger(CeShiapi.class);

    @GetMapping
    public String testSwagger() {
        logger.info("我是日志");
        System.out.println("aaaaaa");
        return "bbbbb";
    }
}

4,启动项目,访问http://localhost:8111/api     成功

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值