简单通用SwaggerConfig配置类

简单通用SwaggerConfig配置类,swagge类似于postman

1、引入依赖

<!--swagger-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <scope>provided </scope>
</dependency>
<!--swagger-ui-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <scope>provided </scope>
</dependency>

2、SwaggerConfig配置类,直接复制到项目

/**
 * @author linZT
 * swagger文档
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

	//页面接口文档1
    @Bean
    public Docket adminApiConfig(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("adminApi")
                .apiInfo(adminApiInfo())
                .select()
                .paths(Predicates.not(PathSelectors.regex("/admin/.*")))
                .paths(Predicates.not(PathSelectors.regex("/error.*")))
                .build();

    }

    private ApiInfo adminApiInfo(){

        return new ApiInfoBuilder()
                .title("swagger,后台接口测试")
                .description("本文档描述了后台项目中的接口定义")
                .version("1.0")
                .contact(new Contact("linZT", "http://linZT.com", "1591731944@qq.com"))
                .build();
    }

	//页面接口文档2
	@Bean
    public Docket webApiConfig(){

        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()
                //只显示api路径下的页面
                .paths(Predicates.and(PathSelectors.regex("/api/.*")))
                .build();
    }

	private ApiInfo webApiInfo(){

        return new ApiInfoBuilder()
                .title("前台网站-API文档")
                .description("本文档描述了前台网站微服务接口定义")
                .version("1.0")
                .contact(new Contact("linZT", "http://linZT.com", "1591731944@qq.com"))
                .build();
    }
    
    //页面接口文档...
}

3、swagger使用方式(注解)

@Api(tags = "用户模块管理") //swagger注解
@RestController
@RequestMapping("/admin/userInfo")
public class UserInfoController {

	@Autowired
    UserInfoService userInfoService;

    @ApiOperation(value = "获取所有用户信息接口")//swagger注解
    @GetMapping("/findAll")
    public Result findAll(){
        List<User> list = userInfoService.list();
        return Result.ok(list);
    }
    
}
  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值