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请求内容等),高质量地创建这份文档本身就是件非常吃力的事,下 ...

随机推荐

myCat读写分离+传统主从
1 Mycat介绍: mycat是最近很火的一款国人发明的分布式数据库中间件,它是基于阿里的cobar的基础上进行开发的准备环境: db01主 10.0.0.51 db02备 10.0.0. ...
转 Jmeter业务请求比例
[转载]Jmeter业务请求比例1 ps:文章转自订阅号“测试那点事儿”,链接:https://mp.weixin.qq.com/s/qVD4iNO0QqRIwAIq9_E_Kw 方法二: 可 ...
spring data jpa 关联设计
MAP关联实体 // @ElementCollection @OneToMany(cascade = {CascadeType.ALL})// @JoinColumn(name = "the ...
数据持久化之轻量级Kv持久化（二）
阿里P7Android高级架构进阶视频免费学习请点击:https://space.bilibili.com/474380680本篇文章将继续从以下两个内容来介绍轻量级Kv持久化: [SharedPre ...
ORACLE中的varchar2()与nvarchar2()的讲解
Oracle中NVARCHAR2和VARCHAR2的区别 [转]NVARCHAR2和VARCHAR2的区别,从使用角度来看区别在于:NVARCHAR2在计算长度时和字符集相关的,例如数据库是中文字符集 ...
13-python基础—python3中的map()
map() 会根据提供的函数对指定序列做映射. 第一个参数 function 以参数序列中的每一个元素调用 function 函数,返回包含每次 function 函数返回值的新列表. 通俗解释: m ...
AOP之PostSharp2-OnMethodBoundaryAspect
在上一篇中我们了解了简单的OnExceptionAspectAOP面向方向切入,在第一节中我们将继续我们的PostSharp AOP系列的OnMethodBoundaryAspect方法行为的切入,这 ...
myeclipse中使用maven插件的时候，报错-Dmaven.multiModuleProjectDirectory system propery is not set.
-Dmaven.multiModuleProjectDirectory system propery is not set. Check $M2_HOME environment variable a ...
Andoid之硬件访问服务1（让Andoid应用程序访问c库）
andoid 项目文件结构图新建Hardcontrol.java package com.thisway.hardlibrary; public class HardControl { public ...
cd 切换
切换

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

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

随机推荐

热门专题