Spring4 & Swagger2
来源:互联网 发布:聊天软件遇见 编辑:程序博客网 时间:2024/05/17 15:57
本篇博客用于记录如何在spring中集成Swagger2.
Swagger2的集成相比较于Swagger1更为的简单。我的项目构建工具是maven,所以Swagger2也是针对于maven的.
第一步在pom.xml加入Swagger2配置
Swagger2的maven包
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.4.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.4.0</version> </dependency>
如果你项目中没有引用fasterxml还需加入配置
<dependency> <groupId>com.fasterxml</groupId> <artifactId>classmate</artifactId> <version>1.3.1</version> </dependency> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-annotations</artifactId> <version>2.3.0</version> </dependency> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-core</artifactId> <version>2.3.1</version> </dependency>
在maven包都导入后需要在spring中配置Swagger的Bean。可以使用xml配置或者java config模式,这里我使用的是java config。配置了包扫描路径
@Configuration@EnableSwagger2@ComponentScan("com.gxj.rest")public class SwaggerConfig { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .genericModelSubstitutes(CommonReqModel.class) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.gxj.rest")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("Spring集成swagger") .description("我的博客:http://blog.csdn.net/qq_16814591/article/details/52223687") .termsOfServiceUrl("http://blog.csdn.net/qq_16814591/article/details/52223687") .contact("路西法'晨星(Moring Star)") .version("1.0") .build(); }}
配置静态资源映射,这边我使用的也是java config
@Configuration@EnableWebMvcpublic class WebAppConfig 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/"); }}
在上面都配置好后只需要在配置对应的json序列化工具就行,我使用的是GSON,Gson需要重新配置下,不然的话得到的会是字符串而不是json。Gson配置如下
public class GsonFactory { public static Gson create() { GsonBuilder gsonBuilder = new GsonBuilder(); gsonBuilder.registerTypeAdapter(Json.class, new SpringfoxJsonToGsonAdapter()); gsonBuilder.registerTypeAdapterFactory(HibernateProxyTypeAdapter.FACTORY); return gsonBuilder.setVersion(1.0).setDateFormat("yyyy-MM-dd HH:mm:ss").create(); } }public class SpringfoxJsonToGsonAdapter implements JsonSerializer<Json> { @Override public JsonElement serialize(Json json, Type type, JsonSerializationContext context) { final JsonParser parser = new JsonParser(); return parser.parse(json.value()); }}
这样swagger2就已经集成进spring了,启动项目后访问/swagger-ui.html就可以看到swagger2的默认界面了。
0 0
- Spring4 & Swagger2
- swagger2
- swagger2
- Swagger2
- dubbo2.5-spring4-mybastis3.2-springmvc4-mongodb3.4-redis3(十)之Spring MVC中使用 Swagger2 构建Restful API
- spring4
- spring4
- spring4
- SpringBoot -- Swagger2
- SpringBoot + Swagger2
- Swagger2用法
- Spring Boot 集成Swagger2
- Springboot集成swagger2
- Spring Boot集成Swagger2
- springmvc+swagger2整合
- spring-boot-swagger2 使用手册
- springboot+swagger2说明
- springboot接入swagger2
- 如何设计出让人眼前一亮的交互框架?
- 【编程素质】代码注释
- 搭建一个App框架及相应的源码分析(EventBus+RxJava+Rxtrofit+OkHttp+Dagger2)及三方SDK等
- Python--第3天:一大波金融Library来袭之numpy篇
- 开发记录——EXCEL导出
- Spring4 & Swagger2
- Java IO流系列(二)—— 字符流
- Java-代理
- 对/proc/cpuinfo文件下的各个参数的说明及实践
- erlang fsm 学习及用例
- logback logback.xml常用配置详解
- 10个很棒的学习Android 开发的网站
- SpringMVC + security模块 框架整合详解
- 没有思想的文章