2. 程式人生 > >springboot整合swagger2企業專案搭建

springboot整合swagger2企業專案搭建

阿新 • • 發佈：2018-12-12

專案包結構圖：

1.本案例使用外部tomcat   

（springboot版本如果太高外接tomcat只能使用8以上）

   博主一開始使用2.0版本springboot 發現專案在tomcat7 下會穩定報錯，一番收縮後表示無解

九月 28, 2018 1:39:24 下午 org.apache.catalina.core.AprLifecycleListener init

資訊: The APR based Apache Tomcat Native library which allows optimal performance in production environments was not found on the java.library.path: /Users/fengyaojie/Library/Java/Extensions:/Library/Java/Extensions:/Network/Library/Java/Extensions:/System/Library/Java/Extensions:/usr/lib/java:.

九月 28, 2018 1:39:25 下午 org.apache.tomcat.util.digester.SetPropertiesRule begin

警告: [SetPropertiesRule]{Server/Service/Engine/Host/Context} Setting property 'source' to 'org.eclipse.jst.jee.server:oneeth-game' did not find a matching property.

九月 28, 2018 1:39:25 下午 org.apache.coyote.AbstractProtocol init

資訊: Initializing ProtocolHandler ["http-bio-9789"]

九月 28, 2018 1:39:25 下午 org.apache.coyote.AbstractProtocol init

資訊: Initializing ProtocolHandler ["ajp-bio-9790"]

九月 28, 2018 1:39:25 下午 org.apache.catalina.startup.Catalina load

資訊: Initialization processed in 1029 ms

九月 28, 2018 1:39:25 下午 org.apache.catalina.core.StandardService startInternal

資訊: Starting service Catalina

九月 28, 2018 1:39:25 下午 org.apache.catalina.core.StandardEngine startInternal

資訊: Starting Servlet Engine: Apache Tomcat/7.0.52

九月 28, 2018 1:39:29 下午 org.apache.catalina.startup.ContextConfig processAnnotationsJar

嚴重: Unable to process Jar entry [module-info.class] from Jar [jar:file:/Users/fengyaojie/Downloads/apache-tomcat-7.0.52/jenkinswebapps/ROOT/oneeth-game/WEB-INF/lib/log4j-api-2.10.0.jar!/] for annotations

org.apache.tomcat.util.bcel.classfile.ClassFormatException: Invalid byte tag in constant pool: 19

at org.apache.tomcat.util.bcel.classfile.Constant.readConstant(Constant.java:136)

at org.apache.tomcat.util.bcel.classfile.ConstantPool.<init>(ConstantPool.java:59)

at org.apache.tomcat.util.bcel.classfile.ClassParser.readConstantPool(ClassParser.java:208)

at org.apache.tomcat.util.bcel.classfile.ClassParser.parse(ClassParser.java:118)

at org.apache.catalina.startup.ContextConfig.processAnnotationsStream(ContextConfig.java:2055)

at org.apache.catalina.startup.ContextConfig.processAnnotationsJar(ContextConfig.java:1931)

at org.apache.catalina.startup.ContextConfig.processAnnotationsUrl(ContextConfig.java:1897)

at org.apache.catalina.startup.ContextConfig.processAnnotations(ContextConfig.java:1882)

at org.apache.catalina.startup.ContextConfig.webConfig(ContextConfig.java:1314)

at org.apache.catalina.startup.ContextConfig.configureStart(ContextConfig.java:873)

at org.apache.catalina.startup.ContextConfig.lifecycleEvent(ContextConfig.java:371)

at org.apache.catalina.util.LifecycleSupport.fireLifecycleEvent(LifecycleSupport.java:117)

at org.apache.catalina.util.LifecycleBase.fireLifecycleEvent(LifecycleBase.java:90)

at org.apache.catalina.core.StandardContext.startInternal(StandardContext.java:5355)

at org.apache.catalina.util.LifecycleBase.start(LifecycleBase.java:150)

at org.apache.catalina.core.ContainerBase$StartChild.call(ContainerBase.java:1559)

at org.apache.catalina.core.ContainerBase$StartChild.call(ContainerBase.java:1549)

at java.util.concurrent.FutureTask.run(FutureTask.java:266)

at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1149)

at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624)

at java.lang.Thread.run(Thread.java:748)

   但是8版本完美啟動，

如果必須使用7版本請將Springboot 版本降低到 1.5.4

<parent>

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

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

<version>1.5.4.RELEASE</version>

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

</parent>

改到低版本後會出現

將import  刪除掉

2.以處理打包多環境配置和多環境日誌列印

多環境如下圖：

日誌處理：

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

<!DOCTYPE configuration>

<configuration debug="true" scan="true" scanPeriod="30 seconds"><!-- 'milliseconds','seconds','minutes' 

and 'hours' -->

    <springProperty scope="context" name="logPath" source="log.path"/>

<springProperty scope="context" name="logCommonLevel" source="log.commonLevel"/>

<springProperty scope="context" name="logSpringLevel" source="log.springLevel"/>

<springProperty scope="context" name="logName"  source="log.name"/>

<contextName>${logName}</contextName>

<jmxConfigurator />

<!-- 控制檯輸出日誌 -->

<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">

<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">

<pattern>%-5level [%contextName] %d{yyyy-MM-dd HH:mm:ss.SSS}

[%thread] %X{req.remoteHost} %X{req.requestURI} %X{username} %logger.%method:%L

- %msg%n</pattern>

</encoder>

</appender>

<!-- 檔案輸出日誌 (檔案大小策略進行檔案輸出，超過指定大小對檔案備份) -->

<appender name="FILE"

class="ch.qos.logback.core.rolling.RollingFileAppender">

<File>${logPath}${logName}.log</File>

<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><!-- rollover daily -->

<FileNamePattern>${logPath}${logName}-log-%d{yyyy-MM-dd}.%i.zip</FileNamePattern>

<timeBasedFileNamingAndTriggeringPolicy

class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">

<maxFileSize>5MB</maxFileSize><!-- or whenever the file size reaches

5MB -->

</timeBasedFileNamingAndTriggeringPolicy>

<!-- <maxHistory></maxHistory> -->

</rollingPolicy>

<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">

<Pattern>%-5level [%contextName] %d{yyyy-MM-dd HH:mm:ss.SSS}

[%thread] %X{req.remoteHost} %X{req.requestURI} %X{username}

%logger.%method:%L - %msg%n</Pattern>

</encoder>

</appender>

<appender name="FILE-ERROR"

class="ch.qos.logback.core.rolling.RollingFileAppender">

<filter class="ch.qos.logback.classic.filter.LevelFilter">

<level>ERROR</level>

<OnMismatch>DENY</OnMismatch>

<OnMatch>ACCEPT</OnMatch>

</filter>

<File>${logPath}${logName}-err.log</File>

<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><!-- rollover daily -->

<FileNamePattern>${logPath}${logName}-log-err-%d{yyyy-MM-dd}.%i.zip</FileNamePattern>

<timeBasedFileNamingAndTriggeringPolicy

class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">

<maxFileSize>5MB</maxFileSize><!-- or whenever the file size reaches

5MB -->

</timeBasedFileNamingAndTriggeringPolicy>

<!-- <maxHistory></maxHistory> -->

</rollingPolicy>

<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">

<Pattern>%-5level [%contextName] %d{yyyy-MM-dd HH:mm:ss.SSS}

[%thread] %X{req.remoteHost} %X{req.requestURI} %X{username}

%logger.%method:%L - %msg%n</Pattern>

</encoder>

</appender>

<!--這裡指定logger name 是為jmx設定日誌級別做鋪墊 -->

<root level="${logCommonLevel}"  >

<appender-ref ref="STDOUT" />

<appender-ref ref="FILE" />

<appender-ref ref="FILE-ERROR" />

</root>

<logger name="com.oneeth"/>

<logger name="org.springframework" level="${logSpringLevel}" additivity="false">

<appender-ref ref="STDOUT" />

<appender-ref ref="FILE-ERROR" />

</logger>

<logger name="org.apache.http.impl.conn.PoolingHttpClientConnectionManager" level="INFO" >

<appender-ref ref="STDOUT" />

</logger>

</configuration>

每個環境列印日誌的路徑和級別 需要將上圖中的配置在每個環境配置檔案中進行賦值如下圖：

然後 我們講講整合swagger2

引入依賴

<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>com.github.xiaoymin</groupId>

<artifactId>swagger-bootstrap-ui</artifactId>

<version>1.8.4</version>

</dependency>

這裡我應為嫌棄swagger2 原生ui醜  所以集成了別人的swagger2—bootstrap—ui

引入依賴後我們需要在專案中配置使用swagger2 

然後就可以使用swagger2 了 如下圖：

在每個介面處都帶上swagger2 的註解和介面的引數和返回值  我們開發完每一個介面  介面文件就可以自動生成了

還可以線上除錯介面

很多東西 無法一一細說！！！請自行研究！

專案已上傳github

路徑為：

相關推薦

springboot整合swagger2企業專案搭建

專案包結構圖： 1.本案例使用外部tomcat    （springboot版本如果太高外接tomcat只能使用8以上）    博主一開始使用2.0版本springboot 發現專案在tomcat7 下會穩定報錯，一番收縮後表示無解 九月 28, 2018

《深入理解Spring Cloud與微服務構建》學習筆記(七)~SpringBoot 整合 Swagger2，搭建線上api文件

一、在專案 pom.xml 引入 swagger 依賴 springfox-swagger2 和 springfox-swagger-ui 如： <dependency> <groupId>io.springfox</groupId>

springboot 完整企業專案搭建實記

昨天搭建ssm框架時突然想到可以搭建springboot來完美解決配置複雜的問題，今天學習了一下springboot的搭建，在此記錄一下搭建的過程和踩過的坑 這裡給自己定一個該框架搭建完成的目標，如下 框架要求功能： - 處理http/json 請求 -

SpringBoot整合Swagger2搭建API在線文檔

type 版本 pri ati 技術 實體類 -c map ans Swagger，中文“拽”的意思，它是一個功能強大的在線API在線文檔，目前它的版本為2.x，所以稱為Swagger2。Swagger2提供了在線文檔的查閱和測試功能。利用Swagger2很容易構建REST

SpringBoot整合Swagger2簡單的例子

設定 tro -c fault rip comment sed itl java Swagger 是一個規範和完整的框架，用於生成、描述、調用和可視化 RESTful 風格的 Web 服務。總體目標是使客戶端和文件系統作為服務器以同樣的速度來更新。文件的方法，參數和模型緊密

5分鐘 springboot 整合swagger2

sed des resources text def mutable rod contact println springboot 整合swagger2 1.maven配置文件中添加依賴 <properties> <swagger2.version

（六）SpringBoot整合Swagger2框架

url selector use contact text exceptio pid urn 自動生成 一：什麽是Swagger Swagger是一款通過我們添加的註解來對方法進行說明，來自動生成項目的在線api接口文檔的web服務。 二：添加Swagger2依賴 <

springboot 整合swagger2

相信很多人都用過postman，使用postman其實可以很簡便的進行介面除錯，但是呢，每次還要寫url，以及要新增引數名字(很容易寫錯)。所以啊，swagger2優勢就體現出來了，它只需要新增少量註解即可在專案下除錯介面，並且可以根據專案是否是測試還是生產環境，可以顯示或禁止頁面介面除錯，介紹

Spring Mvc和SpringBoot整合Swagger2

各位同學大家好，最近專案趕進度，沒有鑽研技術的時間，但碰巧今天需要在Spring專案上進行SpringMvc和Swagger的整合，而第一次使用Swagger是在SpringBoot專案上，因此踩了不少的坑，於是想和大家分享一下 ：關於Swagger在SpringBoot或者和SpringMvc的整

springboot整合dubbo分散式專案Demo

架構演變史： 單一應用架構 當網站流量很小時，只需一個應用，將所有功能都部署在一起，以減少部署節點和成本。 此時，用於簡化增刪改查工作量的 資料訪問框架(ORM) 是關鍵。 垂直應用架構 當訪問量逐漸增大，單一應用增加

SpringBoot整合Swagger2

io.springfox springfox-swagger-ui 2.6.1 二、Swagger配置類 其實這個配置類，只要瞭解具體能配置哪些東西就好了，畢竟這個東西配置一次之後就不用再動了。 特別要注意的是裡面配置了api檔案也就是control

轉載：SpringBoot非官方教程 | 第十一篇：springboot整合swagger2，構建優雅的Restful API

swagger,中文“拽”的意思。它是一個功能強大的api框架，它的整合非常簡單，不僅提供了線上文件的查閱，而且還提供了線上文件的測試。另外swagger很容易構建restful風格的api，簡單優雅帥氣，正如它的名字。 一、引入依賴 <depend

SpringBoot整合swagger2，生成API文件

1、新增依賴 <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --> <dependency>

springboot整合swagger2，lombok

一.瞭解swagger2和lombok （1）Swagger 是一個規範和完整的框架，用於生成、描述、呼叫和視覺化 RESTful 風格的 Web 服務。總體目標是使客戶端和檔案系統作為伺服器以同樣的速度來更新。檔案的方法，引數和模型緊密整合到伺服器端的程式碼，允許AP

[springboot::]整合swagger2,構建RESTful api

1.本來以為會很容易整合的,結果一直報404,試了好久,心累…最後終於找到解決辦法 http://localhost:8080/swagger-ui.html 訪問不到,原因是,是因為 MVC 沒有找到 swagger-ui 包中的 swagger-ui.html 檔案; 但是這個檔案在ja

springboot整合swagger2.0

1、pom.xml新增依賴 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifa

二、SpringBoot 整合 swagger2 (swagger2 版本 2.8.0)

（一）新增依賴 <swagger.version>2.8.0</swagger.version> <!-- swagger2 restful api 文件 start --> <dependency> <gro

java SpringBoot整合Swagger2

原創地址  https://blog.csdn.net/saytime/article/details/74937664#commentBox相信各位在公司寫API文件數量應該不少，當然如果你還處在自己一個人開發前後臺的年代，當我沒說，如今為了前後臺更好的對接，還是為了以後交接方便，都有要求寫API文件。手寫

SpringBoot整合Swagger2生成Api文件

SpringBoot整合Swagger2一、新增Swagger2 pom依賴檔案1、此處為根目錄下pom依賴<properties>    <swagger.version>2.4.0</swagger.version>  </pro

SpringBoot學習筆記-基礎專案搭建

       因為工作需要，最近研究springBoot框架，從零開始什麼都不懂，雖然只是基礎的專案搭建，但是還是遇到了不少的坑，特此記錄下。         首先，現在開發工具上安裝一個spring的外掛（懶人專用），這樣可以直接生成springBoot專案，不用一個檔案