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

快速入门Swagger

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

快速入门Swagger

1.创建web项目 2.引入依赖

    io.springfox
    springfox-swagger2
    2.9.2



     io.springfox
     springfox-swagger-ui
    2.9.2

遇到一个bug:最开始使用的是最新版本3.0.0,两个依赖都是。

无法访问localhost:8080/swagger-ui.html

降了版本就可以了

3.写接口 4.创建一个Swagger配置类:
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean    
    public Docket getDocket1(Environment environment){
        //再创建一个分组
        return new Docket(documentationType.SWAGGER_2).groupName("A");  
    }
    @Bean
    public Docket getDocket(Environment environment){
        //根据环境配置决定能不能用swagger,这里表示测试环境可用
        Profiles profiles = Profiles.of("test");
        boolean b = environment.acceptsProfiles(profiles);
        System.out.println(b);
        return new Docket(documentationType.SWAGGER_2).apiInfo(apiInfo())
                .groupName("向培")    //分组
                .enable(b)          //是否使用swagger
                .select()  
             .apis(RequestHandlerSelectors.basePackage("com.xp.swagger2.controller"))   			//哪些包下可用Swagger
                .build();
    }

    //个人信息
    public Contact concat = new Contact("xiangpei", "www.baidu.com", "2944397754@qq.com");
	//Swagger界面的信息
    private ApiInfo apiInfo(){
        return new ApiInfo("向培学Swagger", "test", "1.0", "urn:tos", concat, "Apache 2.0", "http://www.apache.org/licenses/LICENSE-2.0", new ArrayList());
    }
}

如果接口中使用了实体类,该实体类就会在Model区显示出来;没有使用是不会加载的

几个常用说明注解:

@ApiModel(“用户”) 实体类说明

@ApiModelProperty 属性说明

@ApiOperation(“向培写的helloworld”) 接口说明

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

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

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