栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

Swagger2在java中的入门操作

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

Swagger2在java中的入门操作

1. Swagger2 的maven添加

在使用Swagger2之前是需要添加maven依赖就行了,不用安装其他插件,添加你Maven的时候都会自动添加.
这里使用的是
springFox Swagger2 V2.9.2 的版本
springFox Swagger UI V2.9.2版本
Swagger 官网: swagger.io



    io.springfox
    springfox-swagger2
    2.9.2




    io.springfox
    springfox-swagger-ui
    2.9.2


刷新maven后直接 使用Tomcat端口+swagger-ui.html
例如

 http://localhost:8091/swagger-ui.html

2.Swagger2 配置类

打开idea 创建以个Swagger2Config类
Docket 类中的方法作用介绍
RequestHandlerSelectors 配置包 类 或 方法
basePackage("") 扫描该包下的所有restFul
any() 扫描全部restFul
none() 全不扫描
withMethodAnnotation(PostMapping.class) 扫描方法上的restFul注解的class对象
withMethodAnnotation(RequestMapping.class) 扫描类上的restFul注解的class对象
paths() 路径过滤
enable(false) 开启过关闭swagger2,就是swagger2 的开true关false
groupName(“allow”) 分组

@Configuration
@EnableSwagger2  //开启swagger2
public class Swagger2Config {
//分组
    @Bean 
    public Docket docket1(){return new Docket(documentationType.SWAGGER_2).groupName("A");}
   @Bean    
   public Docket docket2(){return new Docket(documentationType.SWAGGER_2).groupName("B");}
   
    @Bean
    public Docket docket(){//配置swagger2的bean实例
        return new Docket(documentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("allow")
                .enable(true)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.by.baiyue.controller"))
                //.paths(PathSelectors.ant("/doLanding"))
                .build();
    }
   // 配置apiInfo()
    private ApiInfo apiInfo(){
        //作者信息
       Contact contact= new Contact("allow",
                                    "www.baidu.com",
                                    "1303358675@qq.com");
        return  new ApiInfo(
                "allow swagger2",
                "世界之大",
                "V1.0",
                "urn:tos",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList());
    }
}

配置完Swagger2Config类基本上就完成了
对于Swagger2 ui的用法很简单,自己摸索.

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/357740.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号