Swagger 配置

pom

<!-- swagger包 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>swagger-bootstrap-ui</artifactId>
    <version>1.9.2</version>
</dependency>

config

@EnableSwagger2
@Configuration
public class SwaggerConfig {
   @Bean
   public Docket createRestApi() {
      return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))  //只扫描有api注解的类
            .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))    //只扫描有ApiOperation注解的方法
            .apis(RequestHandlerSelectors.basePackage("com.flow.controller"))
            .paths(PathSelectors.any())
            .build()
            ;
   }

   private ApiInfo apiInfo() {
      return new ApiInfoBuilder()
            .title("流向项目API文档")
            .description("restful风格")
            .termsOfServiceUrl("http://127.0.0.1:8055/")
            .version("1.0")
            .build();
   }
}

常用注解

@ApiOperation(value=接口名 notes=入参)   用在Controller 接口方法上  
@Api(value = "目录名" , tags = "目录名" ) 用在Controller类上 
@ApiModelProperty(value = "属性名ID",required = true)  用在实体类上  required标识是否必传

注意:可能会碰到拦截器拦截swagger 请求   提示无Token

解决思路可以尝试  在拦截器放行路径配置里面添加

- /swagger-resources/**
- /webjars/**
- /v2/**
- /swagger-ui.html/**
- /doc.html/**
- /error
- /favicon.ico

访问路径  localhost:8080/doc.html

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

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值