新手上路-搭建项目-springboot-swagger2

XGBCCC 发布于2019-08-14 18:38 / 3518人阅读

摘要：新手上路搭建项目是一个接口文档软件界面如下添加这里使用版本可以正常使用配置文件测试新手上路。

新手上路-搭建项目-springboot-swagger2

swagger2 是一个接口文档软件

界面如下

gradle添加

compile("io.springfox:springfox-swagger2:$swagger2Version")
compile("io.springfox:springfox-swagger-ui:$swaggerUi")

这里使用2.4.0版本可以正常使用

swagger2配置文件

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@EnableSwagger2
@Configuration
public class Swagger2Config {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.seal_de.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("swagger2测试")
                .description("新手上路-swagger2。https://git.oschina.net/sealde/springboot-javaconfig/tree/dev2")
                .termsOfServiceUrl("https://git.oschina.net/sealde/springboot-javaconfig/tree/dev2")
                .version("0.0.1")
                .contact(new Contact("seal_de", "https://git.oschina.net/sealde", "seal.de@foxmail.com"))
                .build();
    }
}

配置资源处理器

@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {
    ...
    
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");

        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
    
    ...
}

注意事项

如果有配置token验证等机制，建议将swagger2的一些请求放行

下面只是一个例子，看实际情况进行配置

@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {
    ...

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
       registry.addInterceptor(new TokenInterceptor(tokenManager))
               .addPathPatterns("/**").excludePathPatterns("/configuration/ui", "/configuration/security", "/v2/api-docs", "/swagger**");
    }
    
    ...
 }

最后

代码（dev2分支）： https://git.oschina.net/seald...

没有在springmvc中配置成功，原因未知

GPU云服务器云服务器 python新手项目 java新手看项目 java新手项目实践 php新手项目推荐

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/67139.html

新人上路-搭建项目-springweb-controller测试

摘要：新人上路搭建项目测试和配置测试最基本的依赖配置添加字符集过滤器解析返回数据静态资源不做处理解析返回数据测试中文测试踩坑记录测试中文测试尚未解决单元测试不知道怎么使用的配置最后代码分支代码分支新人上路-搭建项目-springweb-controller测试 maven和gradle配置测试controller最基本的依赖 maven ...

shiina 2019-08-14 18:38 评论0 收藏0
超详细，新手都能看懂！使用SpringBoot+Dubbo 搭建一个简单的分布式服务

Github 地址：https://github.com/Snailclimb/springboot-integration-examples ，欢迎各位 Star。目录：使用 SpringBoot+Dubbo 搭建一个简单分布式服务实战之前，先来看几个重要的概念什么是分布式? 什么是 Duboo？ Dubbo 架构什么是 RPC？为什么要用 Dubbo？开始实战 1 ...

chengtao1633 2019-08-16 13:52 评论0 收藏0
使用 Nuxt.js 快速搭建服务端渲染(SSR) 应用

摘要：安装官方提功了两种方法来进行项目的初始化，一种是使用团队的脚手架工具，一种是根据自己的需求自由配置使用脚手架适合新手，对后台框架有所了解按照自己需求自由配置，需要对如何配置以及后台框架有所了解。两种方式比较下就是原生和插件的区别。安装 nuxt.js Nuxt.js 官方提功了两种方法来进行项目的初始化，一种是使用Nuxt.js团队的脚手架工具 create-nuxt-app ，一种...

luodongseu 2019-08-26 13:37 评论0 收藏0
使用 Nuxt.js 快速搭建服务端渲染(SSR) 应用

摘要：安装官方提功了两种方法来进行项目的初始化，一种是使用团队的脚手架工具，一种是根据自己的需求自由配置使用脚手架适合新手，对后台框架有所了解按照自己需求自由配置，需要对如何配置以及后台框架有所了解。两种方式比较下就是原生和插件的区别。安装 nuxt.js Nuxt.js 官方提功了两种方法来进行项目的初始化，一种是使用Nuxt.js团队的脚手架工具 create-nuxt-app ，一种...

leanote 2019-06-26 17:59 评论0 收藏0
软件测试需要学什么？50W+的测试工程师需要掌握哪些技能？

摘要：协议学习常见请求方法学习和学习接口的基本概念接口文档认识接口测试用例编写接口测试工具使用软件测试自动化进阶性能测试性能测试的技术要求很高，不仅仅要对性能测试的指标测试分类测试设计有很深刻的理解。 ...

wushuiyong 2021-11-11 16:55 评论0 收藏0