springboot+swagger+版本控制_swagger2的访问地址资源-CSDN文库

共6个文件

java：5个

ds_store：1个

3星 · 超过75%的资源需积分: 49 91 浏览量 2018-10-25 23:03:51 上传评论 2 收藏 7KB ZIP 举报

SpringBoot结合Swagger与版本控制是现代微服务开发中常见的实践，用于构建清晰、可交互的API文档。在本文中，我们将深入探讨如何在SpringBoot项目中整合Swagger，并实现API的版本控制，解决Swagger页面不显示及JSON格式化失效的问题。让我们了解SpringBoot和Swagger。SpringBoot是基于Spring框架的快速开发工具，它简化了设置和配置过程，使得开发者可以更专注于业务逻辑。Swagger则是一个强大的API设计和文档工具，它通过OpenAPI规范来描述RESTful API，使开发者可以生成交互式的文档，方便测试和理解接口。整合SpringBoot和Swagger的第一步是引入相关依赖。在`pom.xml`文件中添加Springfox Swagger的依赖，如： ```xml <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency> ``` 接下来，我们需要配置Swagger。创建一个配置类，比如`SwaggerConfig.java`，并添加以下代码： ```java @Configuration @EnableSwagger2WebMvc public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any()) .build(); } } ``` 这段代码会扫描所有的API路径并生成Swagger文档。对于版本控制，通常我们会为每个版本创建一个单独的API组。可以在Docket配置中使用`tags`方法来指定版本信息： ```java @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any()) .build() .groupName("v1"); // 设置版本号 } ``` 为了实现API的版本控制，可以使用Spring的`@RequestMapping`注解，指定版本号作为路径的一部分，例如： ```java @RestController @RequestMapping("/api/v1") public class V1Controller { // v1版本的接口 } ``` 如果存在v2版本，创建一个新的控制器类`V2Controller`并指定不同的路径： ```java @RestController @RequestMapping("/api/v2") public class V2Controller { // v2版本的接口 } ``` 对于描述中提到的Swagger页面不显示的问题，这可能是因为Swagger的URL未正确访问或者配置问题。默认情况下，Swagger UI可以通过`http://localhost:8080/swagger-ui/index.html`访问。如果无法打开，检查是否正确配置了Swagger，以及应用是否正常运行。 JSON格式化失效可能是由于Jackson库的配置问题。确保项目中包含Jackson的`objectMapper`配置，并启用JSON美化输出： ```java @Bean public Jackson2ObjectMapperBuilder configureObjectMapper() { return new Jackson2ObjectMapperBuilder() .indentOutput(true); // 启用美化输出 } ``` 以上就是关于SpringBoot整合Swagger以及实现版本控制的基本步骤和解决常见问题的方法。在实际开发中，你可能还需要根据具体需求进行调整，如添加自定义的API描述、安全认证等。通过这种方式，你可以创建一个清晰、易于维护且具有版本控制的API文档，提升开发效率和用户体验。

资源推荐

资源详情

资源评论

收起资源包目录

springboot+swagger+版本控制.zip （6个子文件）

springboot+swagger+版本控制

.DS_Store 6KB

CustomRequestMappingHandlerMapping.java 1KB

ApiVersionCondition.java 2KB

ExampleController.java 3KB

WebApiConfig.java 4KB

ApiVersion.java 580B

package cn.com.pchain.config; import java.text.SimpleDateFormat; import java.util.ArrayList; import java.util.List; import org.springframework.boot.SpringBootConfiguration; import org.springframework.http.MediaType; import org.springframework.http.converter.HttpMessageConverter; import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter; import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport; import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping; import com.fasterxml.jackson.databind.ObjectMapper; import cn.com.pchain.interceptor.CustomRequestMappingHandlerMapping; /** * * @author daisy * */ @SpringBootConfiguration public class WebApiConfig extends WebMvcConfigurationSupport { /** * 重写请求过处理的方法 * * @return */ @Override public RequestMappingHandlerMapping requestMappingHandlerMapping() { // return super.requestMappingHandlerMapping(); RequestMappingHandlerMapping handlerMapping = new CustomRequestMappingHandlerMapping(); handlerMapping.setOrder(0); return handlerMapping; } /** * JACKSON格式化处理 */ @Override protected void configureMessageConverters(List<HttpMessageConverter<?>> converters) { MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter = new MappingJackson2HttpMessageConverter(); //设置日期格式 ObjectMapper objectMapper = new ObjectMapper(); SimpleDateFormat smt = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"); objectMapper.setDateFormat(smt); mappingJackson2HttpMessageConverter.setObjectMapper(objectMapper); //设置中文编码格式 List<MediaType> list = new ArrayList<MediaType>(); list.add(MediaType.APPLICATION_JSON_UTF8); mappingJackson2HttpMessageConverter.setSupportedMediaTypes(list); converters.add(mappingJackson2HttpMessageConverter); // NULL返回空字符串 // MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter(); // ObjectMapper objectMapper = new ObjectMapper(); // SimpleModule module = new SimpleModule(); // module.addSerializer(new ToStringSerializer(Long.TYPE)); // module.addSerializer(new ToStringSerializer(Long.class)); // module.addSerializer(new ToStringSerializer(BigInteger.class)); // objectMapper.getSerializerProvider().setNullValueSerializer(new JsonSerializer<Object>() { // public void serialize(Object o, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) // throws IOException { // jsonGenerator.writeString(""); // } // }); // objectMapper.registerModule(module); // converter.setObjectMapper(objectMapper); // 这里是fastJSON的配置方式，更多的内容可以查看SerializerFeature // FastJsonHttpMessageConverter converter = new FastJsonHttpMessageConverter(); // converter.setFeatures(SerializerFeature.WriteNullStringAsEmpty, SerializerFeature.WriteNullNumberAsZero, // SerializerFeature.WriteNullBooleanAsFalse, SerializerFeature.WriteNullListAsEmpty); // converters.add(converter); } /** * swagger静态文件路径过滤 */ @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/"); super.addResourceHandlers(registry); } }

评论收藏

内容反馈