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

pom.xml 包引入






<?xml version="1.0" encoding="UTF-8"?>





<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"





         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">





    <modelVersion>4.0.0</modelVersion>





 





    <groupId>com.example</groupId>





    <artifactId>swagger</artifactId>





    <version>0.0.1-SNAPSHOT</version>





    <packaging>jar</packaging>





 





    <name>swagger</name>





    <description>Demo project for Spring Boot</description>





 





    <!-- 华为Maven镜像 当然你也可以用阿里的-->





    <repositories>





        <repository>





            <id>huaweicloud</id>





            <url>https://repo.huaweicloud.com/repository/maven/</url>





            <!--<url>http://maven.aliyun.com/nexus/content/groups/public/</url>-->





            <releases>





                <enabled>true</enabled>





            </releases>





            <snapshots>





                <enabled>true</enabled>





                <updatePolicy>always</updatePolicy>





                <checksumPolicy>fail</checksumPolicy>





            </snapshots>





        </repository>





    </repositories>





 





    <parent>





        <groupId>org.springframework.boot</groupId>





        <artifactId>spring-boot-starter-parent</artifactId>





        <version>2.0.2.RELEASE</version>





        <relativePath/> <!-- lookup parent from repository -->





    </parent>





 





    <properties>





        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>





        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>





        <java.version>10</java.version>





    </properties>





 





    <dependencies>





        <dependency>





            <groupId>org.springframework.boot</groupId>





            <artifactId>spring-boot-starter-web</artifactId>





        </dependency>





        





        <dependency>





            <groupId>org.springframework.boot</groupId>





            <artifactId>spring-boot-starter-test</artifactId>





            <scope>test</scope>





        </dependency>





 





        <dependency>





            <groupId>io.springfox</groupId>





            <artifactId>springfox-swagger2</artifactId>





            <version>2.8.0</version>





        </dependency>





        <dependency>





            <groupId>io.springfox</groupId>





            <artifactId>springfox-swagger-ui</artifactId>





            <version>2.8.0</version>





        </dependency>





 





        <dependency>





            <groupId>javax.xml.bind</groupId>





            <artifactId>jaxb-api</artifactId>





            <version>2.3.0</version>





        </dependency>





    </dependencies>





 





    <build>





        <plugins>





            <plugin>





                <groupId>org.springframework.boot</groupId>





                <artifactId>spring-boot-maven-plugin</artifactId>





            </plugin>





        </plugins>





    </build>





 





 





</project>

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

以下为代码配置:






package net.ainio.config;





 





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.spi.DocumentationType;





import springfox.documentation.spring.web.plugins.Docket;





import springfox.documentation.swagger2.annotations.EnableSwagger2;





 





@Configuration





@EnableSwagger2





public class SwaggerConfig {





    @Bean





    public Docket api() {





        return new Docket(DocumentationType.SWAGGER_2)





                .apiInfo(apiInfo())





                .select()





                // 自行修改为自己的包路径





                .apis(RequestHandlerSelectors.basePackage("net.ainio.controller"))





                .paths(PathSelectors.any())





                .build();





    }





 





    private ApiInfo apiInfo() {





        return new ApiInfoBuilder()





                .title("api文档")





                .description("restfun 风格接口")





                //服务条款网址





                //.termsOfServiceUrl("http://blog.csdn.net/forezp")





                .version("1.0")





                //.contact(new Contact("帅呆了", "url", "email"))





                .build();





    }





}

测试controller

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

@RestController

@Controller






package net.ainio.controller;





 





import io.swagger.annotations.Api;





import io.swagger.annotations.ApiImplicitParam;





import io.swagger.annotations.ApiOperation;





import org.apache.catalina.User;





import org.springframework.web.bind.annotation.*;





 





@Api(value="/test", tags="测试接口模块")





@RestController





@RequestMapping("/test")





public class TestSwaggerController {





    @ApiOperation(value="展示首页信息", notes = "展示首页信息")





    @GetMapping("/show")





    public Object showInfo(){





        return "hello world";





    }





 





    @ApiOperation(value="添加用户信息", notes = "添加用户信息")





    @ApiImplicitParam(name="user", value="User", required = true, dataType = "User")





    @PostMapping("/addUser")





    public Object addUser(@RequestBody User user){





        return "success";





    }





}

启动后访问

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

2018 最新 spring boot 整合 swagger2 (swagger2 版本 2.8.0)的更多相关文章

spring boot 整合mybatis + swagger2
之前使用springMVC+spring+mybatis,总是被一些繁琐的xml配置,有时候如果配置出错,还要检查各种xml配置,偶然接触到了spring boot 后发现搭建一个web项目真的是1分 ...
Spring Boot整合JPA、Redis和Swagger2
好久没有总结了,最近也一直在学习.今天就把spring boot与其它技术的整合做个小总结,主要是jpa.redis和swagger2.公司里有用到这些,整合起来也很简单. 首先,新建一个Spring ...
spring boot整合Swagger2
Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化RESTful风格的 Web 服务.总体目标是使客户端和文件系统作为服务器以同样的速度来更新.文件的方法,参数和模型紧密集成到服务器 ...
Spring Boot 项目学习 (四) Spring Boot整合Swagger2自动生成API文档
0 引言在做服务端开发的时候,难免会涉及到API 接口文档的编写,可以经历过手写API 文档的过程,就会发现,一个自动生成API文档可以提高多少的效率. 以下列举几个手写API 文档的痛点: 文档需 ...
spring boot 整合 swagger2
swagger2为了更好的管理api文档接口 swagger构建的api文档如下,清晰,避免了手写api诸多痛点一,添加依赖  <depen ...
Spring Boot中使用Swagger2构建强大的RESTful API文档
由于Spring Boot能够快速开发.便捷部署等特性,相信有很大一部分Spring Boot的用户会用来构建RESTful API.而我们构建RESTful API的目的通常都是由于多终端的原因,这 ...
Spring Boot中使用Swagger2自动构建API文档
由于Spring Boot能够快速开发.便捷部署等特性,相信有很大一部分Spring Boot的用户会用来构建RESTful API.而我们构建RESTful API的目的通常都是由于多终端的原因,这 ...
Spring Boot中使用Swagger2构建RESTful API文档
在开发rest api的时候,为了减少与其他团队平时开发期间的频繁沟通成本,传统做法我们会创建一份RESTful API文档来记录所有接口细节,然而这样的做法有以下几个问题: 1．由于接口众多,并且细 ...
Spring Boot 中使用 Swagger2 构建强大的 RESTful API 文档
项目现状:由于前后端分离,没有很好的前后端合作工具. 由于接口众多,并且细节复杂(需要考虑不同的HTTP请求类型.HTTP头部信息.HTTP请求内容等),高质量地创建这份文档本身就是件非常吃力的事,下 ...

随机推荐

常用内置模块（一）——time、os、sys、random、shutil、pickle、json
常用内置模块一.time模块在python中,时间分为3种 1.时间戳: timestamp,从1970年1月1日到现在的秒数, 主要用于计算两个时间的差 2.localtime ...
分布式-技术专区-Redis分布式锁实现-第二步
再上次篇章中汇集了相关的分布式锁的概念进行控制,接下来我们采用的是注解声明式开发服务方案,进行声明式开发代替编程式开发方案. 1.利用aop实现分布式锁2.只用在方法上加个注解,同时加上了重试机制 ...
java爬取读者文摘杂志
java爬虫入门实战练习此代码仅用于学习研究此次练习选择了读者文摘杂志网站进行文章爬取练习中用到的都只是一些简单的方法,不过过程中复习了输入流输出流的使用以及文件的创建写入等知识,对自己还是有所 ...
koa2 的处理请求体koa-bodyparser koa-router 的中间件的学习
1.官网 https://www.npmjs.com/package/koa-router https://www.npmjs.com/package/koa-bodyparser 2. demo / ...
springboot集成使用rabbitmq笔记(3.基本过程)
使用rabbitmq笔记一使用rabbitmq笔记二使用rabbitmq笔记三 1.AMQP协议 AMQP 0-9-1的工作过程如下图:消息(message)被发布者(publisher)发送给交 ...
react-devtools超级简单安装教程
有时候看网上各路大神,写如何安装react-devtools,大神就是大神,好多步骤一笔带过,导致一些学习者看的一脸懵逼,今天我给大家讲超级简单的react-devtools安装步骤,相信看过的小伙伴 ...
vue 表格多选换页保存前一页的状态
表格多选点击下一页,上一页的状态没消失. 在表格添加 row-key="id" 在表格行里添加 reserve-selection
go变量和声明
go变量和声明这将是美好的开始和结束,通过写下x = 4,我们查看变量,可以说声明了一个变量并赋值,但是很不幸,go语言变量声明和赋值比这更复杂.通过学习一些简单的示例开始学习变量声明和赋值.然后在 ...
php linux下安装xml扩展
1.进入PHP安装源码包,找到ext下的ftp,进入 cd /home/local/php-5.6.25/ext/xml 2./usr/local/php/bin/phpize 3../configu ...
DOM学习总结（二）
一.什么是DOM属性 DOM属性简单来说就是HTML的属性值二.常见的DOM属性有哪些? 1.innerHTML 属性获取元素的内容,想要拿到某个元素的文本内容,直接在后面加 .innerHTML ...

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

2018 最新 spring boot 整合 swagger2 (swagger2 版本 2.8.0)的更多相关文章

随机推荐

热门专题