菜鸟的学习之路----Springboot项目配置Swagger--maven方式

如何向已有的spring-boot引入swagger
以下三步

- 1、pom.xml文件引入jar包

 <properties><swagger.version>2.8.0</swagger.version></properties><!--swagger--><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>${swagger.version}</version></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>${swagger.version}</version></dependency>

2新建一个Swagger.configer类，并做以下配置

 @Value(value = "${swagger.enabled}")//enabled在yml中配置不然会报错Boolean SwaggerEnable;@Beanpublic Docket createRestApi() {// 添加请求参数，我们这里把token作为请求头部参数传入后端return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())// 是否开启.enable(SwaggerEnable).select()// 扫描的路径包.apis(RequestHandlerSelectors.basePackage("com.cdht.sac"))//此处填写包的路径// 指定路径处理PathSelectors.any()代表所有的路径.paths(PathSelectors.any()).build().pathMapping("/");}private ApiInfo apiInfo() {return new ApiInfoBuilder().title(“xxx API Doc").version("1.0.0").build();}

3配置文件yml的配置

#端口请求
server:tomcat:uri-encoding: UTF-8max-threads: 1000max-connections: 20000max-http-post-size: 1024000max-http-header-size: 1024000#以下端口和访问接口名称port: 8088#配置好端口，注意不要把port写到tomcat了，port的父目录为serverservlet:context-path: #自定义访问接口名称# 数据库配置
spring:datasource:driverClassName: oracle.jdbc.driver.OracleDriverurl: jdbc:oracle:xxx:@ip/orclusername: xxpassword: xxmax-idle: 10initial-size: 5max-wait: 10000min-idle: 5mybatis:mapper-locations: classpath:mappers/*.xml type-aliases-package: com.cdht.sac.entity#实体类包路径
#配置日志
logging:level:org.springframework.boot.autoconfigure: ERRORthymeleaf:cache:false
#swagger配置，这个很重要
swagger:enabled: true
debug: true

所有配置完成
在contoller类上引用@Api

在controller的内中命名功能组件
启动项目–检查端口是否成功启动
8088端口成功启动
访问swagger页面
http://localhost:8088/你配置的接口名字/swagger-ui.html

菜鸟的学习之路----Springboot项目配置Swagger--maven方式相关推荐

springboot项目配置视图解析器无效的问题
springboot项目配置视图解析器无效的问题今天springboot尝试配置视图解析器的时候,如图: 一切正常,视图解析器却始终无效.后面发现问题. 在控制器的注解要使用:@Controller ...
SpringBoot项目配置明文密码泄露问题的处理方式
SpringBoot项目配置明文密码泄露问题的处理方式: 1.引入jar包 <dependency> <groupId>com.github.ulisesbocchio ...
IDEA SpringBoot项目配置热更新，无需每次手动重启服务器
IDEA SpringBoot项目配置热更新的步骤在pom.xml中添加依赖: <dependency><groupId>org.springframework.boot&l ...
快速搭建Springboot项目的两种方式！！
大家好,我是雄雄,欢迎关注微信公众号[雄雄的小课堂]. 前言 Springboot的特点就是简单.快速和方便,使用idea不到一分钟就可以快速搭建springboot项目,并且,在这里,你不用写spr ...
springboot项目推荐的打包方式以及springboot项目的瘦身！！！！
1.springboot项目推荐的打包方式 springboot有两种打包方式,分别是打包成war包和打包成jar包.打包成war包放在tomcat的webapp目录下,随着tomcat的启动,即可访 ...
大数据学习之路（电脑配置）
大数据学习之路第一天:大数据环境搭建(电脑配置) 一想到大数据,我们可能想到的是大数据可视化平台,展示的有多么的炫酷,可是你可能没有想到的是大数据中数据的存储,数据的计算(mapreduce)会是有 ...
Springboot项目配置404错误页面
项目结构,错误页面路径因为下面这个项目静态文件的路径是springboot项目默认路径,所以application.properties都不用配置. 全局错误页面配置类: import org.s ...
springboot学习(六十七) springboot项目通过gradle-docker-plugin插件构建为doker镜像并推送至镜像私服
文章目录前言 1.使用gradle部署springboot项目 2.Docker开启远程访问 3.安装镜像私服Harbor 4.gradle中配置插件前言 springboot从2.4默认提供了打 ...
springboot项目配置（yml，pom）
首先使用idea创建一个纯净的springboot项目 1,替换pom文件 <?xml version="1.0" encoding="UTF-8"?&g ...

菜鸟的学习之路----Springboot项目配置Swagger--maven方式

菜鸟的学习之路----Springboot项目配置Swagger--maven方式相关推荐

最新文章

热门文章