2018 最新 spring boot 整合 swagger2 (swagger2 版本 2.8.0)

好久没上了, 看到又有人回复了. 我就来修改一下. 修改时间  2018年5月16日

这回给你上全新版本. 至发稿时间,所有的包都是新版. 

注意: 高版本需要添加  jaxb-api 包, 否则会报错. 最下面列出报错信息

2018年5月17日更新  jdk8 不需要添加  jaxb-api

版本:

    jdk 10

    spring boot 2.0.2

    swagger 2.8.0

  1.  pom.xml 包引入
 
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <modelVersion>4.0.0</modelVersion>
  5.  
  6.     <groupId>com.example</groupId>
  7.     <artifactId>swagger</artifactId>
  8.     <version>0.0.1-SNAPSHOT</version>
  9.     <packaging>jar</packaging>
  10.  
  11.     <name>swagger</name>
  12.     <description>Demo project for Spring Boot</description>
  13.  
  14.     <!-- 华为Maven镜像 当然你也可以用阿里的-->
  15.     <repositories>
  16.         <repository>
  17.             <id>huaweicloud</id>
  18.             <url>https://repo.huaweicloud.com/repository/maven/</url>
  19.             <!--<url>http://maven.aliyun.com/nexus/content/groups/public/</url>-->
  20.             <releases>
  21.                 <enabled>true</enabled>
  22.             </releases>
  23.             <snapshots>
  24.                 <enabled>true</enabled>
  25.                 <updatePolicy>always</updatePolicy>
  26.                 <checksumPolicy>fail</checksumPolicy>
  27.             </snapshots>
  28.         </repository>
  29.     </repositories>
  30.  
  31.     <parent>
  32.         <groupId>org.springframework.boot</groupId>
  33.         <artifactId>spring-boot-starter-parent</artifactId>
  34.         <version>2.0.2.RELEASE</version>
  35.         <relativePath/> <!-- lookup parent from repository -->
  36.     </parent>
  37.  
  38.     <properties>
  39.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  40.         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  41.         <java.version>10</java.version>
  42.     </properties>
  43.  
  44.     <dependencies>
  45.         <dependency>
  46.             <groupId>org.springframework.boot</groupId>
  47.             <artifactId>spring-boot-starter-web</artifactId>
  48.         </dependency>
  49.         
  50.         <dependency>
  51.             <groupId>org.springframework.boot</groupId>
  52.             <artifactId>spring-boot-starter-test</artifactId>
  53.             <scope>test</scope>
  54.         </dependency>
  55.  
  56.         <dependency>
  57.             <groupId>io.springfox</groupId>
  58.             <artifactId>springfox-swagger2</artifactId>
  59.             <version>2.8.0</version>
  60.         </dependency>
  61.         <dependency>
  62.             <groupId>io.springfox</groupId>
  63.             <artifactId>springfox-swagger-ui</artifactId>
  64.             <version>2.8.0</version>
  65.         </dependency>
  66.  
  67.         <dependency>
  68.             <groupId>javax.xml.bind</groupId>
  69.             <artifactId>jaxb-api</artifactId>
  70.             <version>2.3.0</version>
  71.         </dependency>
  72.     </dependencies>
  73.  
  74.     <build>
  75.         <plugins>
  76.             <plugin>
  77.                 <groupId>org.springframework.boot</groupId>
  78.                 <artifactId>spring-boot-maven-plugin</artifactId>
  79.             </plugin>
  80.         </plugins>
  81.     </build>
  82.  
  83.  
  84. </project>

 

先检查Maven中包是否导入, 以下以idea为列. 看是否有 swagger-ui 这个包

 

 

以下为代码配置:

 

  1. package net.ainio.config;
  2.  
  3. import org.springframework.context.annotation.Bean;
  4. import org.springframework.context.annotation.Configuration;
  5. import springfox.documentation.builders.ApiInfoBuilder;
  6. import springfox.documentation.builders.PathSelectors;
  7. import springfox.documentation.builders.RequestHandlerSelectors;
  8. import springfox.documentation.service.ApiInfo;
  9. import springfox.documentation.spi.DocumentationType;
  10. import springfox.documentation.spring.web.plugins.Docket;
  11. import springfox.documentation.swagger2.annotations.EnableSwagger2;
  12.  
  13. @Configuration
  14. @EnableSwagger2
  15. public class SwaggerConfig {
  16.     @Bean
  17.     public Docket api() {
  18.         return new Docket(DocumentationType.SWAGGER_2)
  19.                 .apiInfo(apiInfo())
  20.                 .select()
  21.                 // 自行修改为自己的包路径
  22.                 .apis(RequestHandlerSelectors.basePackage("net.ainio.controller"))
  23.                 .paths(PathSelectors.any())
  24.                 .build();
  25.     }
  26.  
  27.     private ApiInfo apiInfo() {
  28.         return new ApiInfoBuilder()
  29.                 .title("api文档")
  30.                 .description("restfun 风格接口")
  31.                 //服务条款网址
  32.                 //.termsOfServiceUrl("http://blog.csdn.net/forezp")
  33.                 .version("1.0")
  34.                 //.contact(new Contact("帅呆了", "url", "email"))
  35.                 .build();
  36.     }
  37. }

 

测试controller

注意下这两个的区别哦, 不然前台会返回 404 错误

@RestController
@Controller
  1. package net.ainio.controller;
  2.  
  3. import io.swagger.annotations.Api;
  4. import io.swagger.annotations.ApiImplicitParam;
  5. import io.swagger.annotations.ApiOperation;
  6. import org.apache.catalina.User;
  7. import org.springframework.web.bind.annotation.*;
  8.  
  9. @Api(value="/test", tags="测试接口模块")
  10. @RestController
  11. @RequestMapping("/test")
  12. public class TestSwaggerController {
  13.     @ApiOperation(value="展示首页信息", notes = "展示首页信息")
  14.     @GetMapping("/show")
  15.     public Object showInfo(){
  16.         return "hello world";
  17.     }
  18.  
  19.     @ApiOperation(value="添加用户信息", notes = "添加用户信息")
  20.     @ApiImplicitParam(name="user", value="User", required = true, dataType = "User")
  21.     @PostMapping("/addUser")
  22.     public Object addUser(@RequestBody User user){
  23.         return "success";
  24.     }
  25. }

 

启动后访问

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

 

 

感谢 Michael_Zhan_Tcys 网友

 

下面列出, 不添加 jabx-api的报错信息

 



Error starting ApplicationContext. To display the conditions report re-run your application with 'debug' enabled.
2018-05-16 23:16:20.452 ERROR 10220 --- [  restartedMain] o.s.boot.SpringApplication               : Application run failed


org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'xmlModelPlugin': Lookup method resolution failed; nested exception is java.lang.IllegalStateException: Failed to introspect Class [springfox.documentation.schema.XmlModelPlugin] from ClassLoader [jdk.internal.loader.ClassLoaders$AppClassLoader@4629104a]
at org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor.determineCandidateConstructors(AutowiredAnnotationBeanPostProcessor.java:262) ~[spring-beans-5.0.6.RELEASE.jar:5.0.6.RELEASE]
at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.determineConstructorsFromBeanPostProcessors(AbstractAutowireCapableBeanFactory.java:1202) ~[spring-beans-5.0.6.RELEASE.jar:5.0.6.RELEASE]
at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.createBeanInstance(AbstractAutowireCapableBeanFactory.java:1127) ~[spring-beans-5.0.6.RELEASE.jar:5.0.6.RELEASE]
at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.doCreateBean(AbstractAutowireCapableBeanFactory.java:541) ~[spring-beans-5.0.6.RELEASE.jar:5.0.6.RELEASE]
at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.createBean(AbstractAutowireCapableBeanFactory.java:501) ~[spring-beans-5.0.6.RELEASE.jar:5.0.6.RELEASE]
at org.springframework.beans.factory.support.AbstractBeanFactory.lambda$doGetBean$0(AbstractBeanFactory.java:317) ~[spring-beans-5.0.6.RELEASE.jar:5.0.6.RELEASE]
at org.springframework.beans.factory.support.DefaultSingletonBeanRegistry.getSingleton(DefaultSingletonBeanRegistry.java:228) ~[spring-beans-5.0.6.RELEASE.jar:5.0.6.RELEASE]
at org.springframework.beans.factory.support.AbstractBeanFactory.doGetBean(AbstractBeanFactory.java:315) ~[spring-beans-5.0.6.RELEASE.jar:5.0.6.RELEASE]
at org.springframework.beans.factory.support.AbstractBeanFactory.getBean(AbstractBeanFactory.java:199) ~[spring-beans-5.0.6.RELEASE.jar:5.0.6.RELEASE]
at org.springframework.beans.factory.support.DefaultListableBeanFactory.preInstantiateSingletons(DefaultListableBeanFactory.java:760) ~[spring-beans-5.0.6.RELEASE.jar:5.0.6.RELEASE]
at org.springframework.context.support.AbstractApplicationContext.finishBeanFactoryInitialization(AbstractApplicationContext.java:869) ~[spring-context-5.0.6.RELEASE.jar:5.0.6.RELEASE]
at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:550) ~[spring-context-5.0.6.RELEASE.jar:5.0.6.RELEASE]
at org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext.refresh(ServletWebServerApplicationContext.java:140) ~[spring-boot-2.0.2.RELEASE.jar:2.0.2.RELEASE]
at org.springframework.boot.SpringApplication.refresh(SpringApplication.java:759) [spring-boot-2.0.2.RELEASE.jar:2.0.2.RELEASE]
at org.springframework.boot.SpringApplication.refreshContext(SpringApplication.java:395) [spring-boot-2.0.2.RELEASE.jar:2.0.2.RELEASE]
at org.springframework.boot.SpringApplication.run(SpringApplication.java:327) [spring-boot-2.0.2.RELEASE.jar:2.0.2.RELEASE]
at org.springframework.boot.SpringApplication.run(SpringApplication.java:1255) [spring-boot-2.0.2.RELEASE.jar:2.0.2.RELEASE]
at org.springframework.boot.SpringApplication.run(SpringApplication.java:1243) [spring-boot-2.0.2.RELEASE.jar:2.0.2.RELEASE]
at com.example.SwaggerApplication.main(SwaggerApplication.java:10) [classes/:na]
at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method) ~[na:na]
at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62) ~[na:na]
at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) ~[na:na]
at java.base/java.lang.reflect.Method.invoke(Method.java:564) ~[na:na]
at org.springframework.boot.devtools.restart.RestartLauncher.run(RestartLauncher.java:49) [spring-boot-devtools-2.0.2.RELEASE.jar:2.0.2.RELEASE]
Caused by: java.lang.IllegalStateException: Failed to introspect Class [springfox.documentation.schema.XmlModelPlugin] from ClassLoader [jdk.internal.loader.ClassLoaders$AppClassLoader@4629104a]
at org.springframework.util.ReflectionUtils.getDeclaredMethods(ReflectionUtils.java:659) ~[spring-core-5.0.6.RELEASE.jar:5.0.6.RELEASE]
at org.springframework.util.ReflectionUtils.doWithMethods(ReflectionUtils.java:556) ~[spring-core-5.0.6.RELEASE.jar:5.0.6.RELEASE]
at org.springframework.util.ReflectionUtils.doWithMethods(ReflectionUtils.java:541) ~[spring-core-5.0.6.RELEASE.jar:5.0.6.RELEASE]
at org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor.determineCandidateConstructors(AutowiredAnnotationBeanPostProcessor.java:245) ~[spring-beans-5.0.6.RELEASE.jar:5.0.6.RELEASE]
... 23 common frames omitted
Caused by: java.lang.NoClassDefFoundError: javax/xml/bind/annotation/XmlType
at java.base/java.lang.Class.getDeclaredMethods0(Native Method) ~[na:na]
at java.base/java.lang.Class.privateGetDeclaredMethods(Class.java:3119) ~[na:na]
at java.base/java.lang.Class.getDeclaredMethods(Class.java:2268) ~[na:na]
at org.springframework.util.ReflectionUtils.getDeclaredMethods(ReflectionUtils.java:641) ~[spring-core-5.0.6.RELEASE.jar:5.0.6.RELEASE]
... 26 common frames omitted
Caused by: java.lang.ClassNotFoundException: javax.xml.bind.annotation.XmlType
at java.base/jdk.internal.loader.BuiltinClassLoader.loadClass(BuiltinClassLoader.java:582) ~[na:na]
at java.base/jdk.internal.loader.ClassLoaders$AppClassLoader.loadClass(ClassLoaders.java:190) ~[na:na]
at java.base/java.lang.ClassLoader.loadClass(ClassLoader.java:499) ~[na:na]
... 30 common frames omitted




Process finished with exit code 0

 

本文链接：https://blog.csdn.net/aPiFen/article/details/79397100

posted @ 2019-09-02 11:30  星朝  阅读(3423)  评论(0)  编辑  收藏  举报