├── .gitignore ├── .travis.yml ├── LICENSE ├── README.md ├── build.gradle ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── settings.gradle └── src ├── main └── java │ └── springboot │ └── swagger │ ├── ServletContextPathProvider.java │ └── SpringBootSwaggerConfig.java └── test └── java └── springboot └── swagger └── SpringBootSwaggerTest.java /.gitignore: -------------------------------------------------------------------------------- 1 | build 2 | *.class 3 | *.iml 4 | .gradle 5 | .idea 6 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: java 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Spring-boot-swagger 2 | =================== 3 | Dead simple [Swagger](https://github.com/wordnik/swagger-ui) config for [Spring Boot](https://github.com/spring-projects/spring-boot). 4 | 5 | [![Build Status](https://travis-ci.org/pjagielski/spring-boot-swagger.svg?branch=master)](https://travis-ci.org/pjagielski/spring-boot-swagger) 6 | 7 | Motivation 8 | ========== 9 | Spring Boot is one of the hottest JVM frameworks in the microservice area. The only missing part for me is integration with Swagger — de facto standard for documenting REST services. There is a great [swagger-springmvc](https://github.com/martypitt/swagger-springmvc) library for Spring MVC, but its configuration seems to be too verbose for microservices. This project provides sensible defaults for swagger-springmvc which let you expose Swagger docs in just a few lines of code. 10 | 11 | Usage 12 | ===== 13 | Spring-boot-swagger is available for download from the Maven Central repository. 14 | 15 | Maven: 16 | ```xml 17 | 18 |     com.github.pjagielski.spring-boot-swagger 19 |     spring-boot-swagger 20 |     0.1 21 | 22 | ``` 23 | 24 | Grab: 25 | ```groovy 26 | @Grab('com.github.pjagielski.spring-boot-swagger:spring-boot-swagger:0.1') 27 | ``` 28 | 29 | Examples 30 | ======== 31 | Sample `app.groovy`: 32 | ```groovy 33 | @Grab('org.springframework.boot:spring-boot-starter-actuator:1.0.2.RELEASE') 34 | @Grab('org.springframework:spring-web:4.0.3.RELEASE') 35 | @Grab('com.github.pjagielski.spring-boot-swagger:spring-boot-swagger:0.1') 36 | 37 | import com.mangofactory.swagger.configuration.SpringSwaggerConfig 38 | import com.wordnik.swagger.annotations.ApiOperation 39 | import org.springframework.context.annotation.Configuration 40 | import org.springframework.context.annotation.Import 41 | import org.springframework.web.bind.annotation.RequestMapping 42 | import org.springframework.web.bind.annotation.RestController 43 | import springboot.swagger.SpringBootSwaggerConfig 44 | 45 | import static org.springframework.web.bind.annotation.RequestMethod.GET 46 | 47 | @RestController 48 | class SampleController { 49 | 50 | @RequestMapping(value = "/messages", method = GET) 51 | @ApiOperation("hello world") 52 | Message hello() { 53 | new Message(text: "Hello world!") 54 | } 55 | } 56 | 57 | class Message { 58 | String text 59 | } 60 | 61 | @Configuration 62 | @Import(SpringSwaggerConfig) 63 | class SwaggerConfig extends SpringBootSwaggerConfig { 64 | 65 | @Override 66 | protected List getIncludePatterns() { 67 | ['/messages.*'] 68 | } 69 | 70 | @Override 71 | protected String getSwaggerGroup() { 72 | 'messages' 73 | } 74 | } 75 | ``` 76 | -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: 'java' 2 | apply plugin: 'maven' 3 | apply plugin: 'signing' 4 | 5 | group = 'com.github.pjagielski.spring-boot-swagger' 6 | 7 | sourceCompatibility = 1.7 8 | version = '0.1' 9 | 10 | repositories { 11 | mavenCentral() 12 | } 13 | 14 | ext { 15 | springBootVersion = "1.0.2.RELEASE" 16 | springVersion = "4.0.3.RELEASE" 17 | } 18 | 19 | task javadocJar(type: Jar, dependsOn: javadoc) { 20 | classifier = 'javadoc' 21 | from 'build/docs/javadoc' 22 | } 23 | 24 | task sourcesJar(type: Jar) { 25 | from sourceSets.main.allSource 26 | classifier = 'sources' 27 | } 28 | 29 | artifacts { 30 | archives javadocJar, sourcesJar 31 | } 32 | 33 | dependencies { 34 | compile("org.springframework.boot:spring-boot-starter:$springBootVersion") 35 | compile("org.springframework.boot:spring-boot-starter-web:$springBootVersion") 36 | 37 | compile("org.springframework:spring-web:$springVersion") 38 | compile("org.springframework:spring-webmvc:$springVersion") 39 | compile('com.mangofactory:swagger-springmvc:0.8.3') { 40 | exclude group: 'org.springframework', module: 'spring-aop' 41 | exclude group: 'org.springframework', module: 'spring-beans' 42 | exclude group: 'org.springframework', module: 'spring-context' 43 | exclude group: 'org.springframework', module: 'spring-core' 44 | exclude group: 'org.springframework', module: 'spring-expression' 45 | exclude group: 'org.springframework', module: 'spring-web' 46 | exclude group: 'org.springframework', module: 'spring-webmvc' 47 | } 48 | compile('javax.servlet:javax.servlet-api:3.1.0') 49 | testCompile('junit:junit:4.11') 50 | testCompile("org.springframework:spring-test:$springVersion") 51 | testCompile ('com.jayway.restassured:rest-assured:2.3.1') { 52 | exclude(module: 'groovy') 53 | } 54 | testCompile('org.codehaus.groovy:groovy-all:2.2.1') 55 | } -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/pjagielski/spring-boot-swagger/55cdd95f948df91a0ebfbf0edc8d3259be189243/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Sat May 03 22:47:07 CEST 2014 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=http\://services.gradle.org/distributions/gradle-1.9-all.zip 7 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 10 | DEFAULT_JVM_OPTS="" 11 | 12 | APP_NAME="Gradle" 13 | APP_BASE_NAME=`basename "$0"` 14 | 15 | # Use the maximum available, or set MAX_FD != -1 to use that value. 16 | MAX_FD="maximum" 17 | 18 | warn ( ) { 19 | echo "$*" 20 | } 21 | 22 | die ( ) { 23 | echo 24 | echo "$*" 25 | echo 26 | exit 1 27 | } 28 | 29 | # OS specific support (must be 'true' or 'false'). 30 | cygwin=false 31 | msys=false 32 | darwin=false 33 | case "`uname`" in 34 | CYGWIN* ) 35 | cygwin=true 36 | ;; 37 | Darwin* ) 38 | darwin=true 39 | ;; 40 | MINGW* ) 41 | msys=true 42 | ;; 43 | esac 44 | 45 | # For Cygwin, ensure paths are in UNIX format before anything is touched. 46 | if $cygwin ; then 47 | [ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --unix "$JAVA_HOME"` 48 | fi 49 | 50 | # Attempt to set APP_HOME 51 | # Resolve links: $0 may be a link 52 | PRG="$0" 53 | # Need this for relative symlinks. 54 | while [ -h "$PRG" ] ; do 55 | ls=`ls -ld "$PRG"` 56 | link=`expr "$ls" : '.*-> \(.*\)$'` 57 | if expr "$link" : '/.*' > /dev/null; then 58 | PRG="$link" 59 | else 60 | PRG=`dirname "$PRG"`"/$link" 61 | fi 62 | done 63 | SAVED="`pwd`" 64 | cd "`dirname \"$PRG\"`/" >&- 65 | APP_HOME="`pwd -P`" 66 | cd "$SAVED" >&- 67 | 68 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 69 | 70 | # Determine the Java command to use to start the JVM. 71 | if [ -n "$JAVA_HOME" ] ; then 72 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 73 | # IBM's JDK on AIX uses strange locations for the executables 74 | JAVACMD="$JAVA_HOME/jre/sh/java" 75 | else 76 | JAVACMD="$JAVA_HOME/bin/java" 77 | fi 78 | if [ ! -x "$JAVACMD" ] ; then 79 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 80 | 81 | Please set the JAVA_HOME variable in your environment to match the 82 | location of your Java installation." 83 | fi 84 | else 85 | JAVACMD="java" 86 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 87 | 88 | Please set the JAVA_HOME variable in your environment to match the 89 | location of your Java installation." 90 | fi 91 | 92 | # Increase the maximum file descriptors if we can. 93 | if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then 94 | MAX_FD_LIMIT=`ulimit -H -n` 95 | if [ $? -eq 0 ] ; then 96 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 97 | MAX_FD="$MAX_FD_LIMIT" 98 | fi 99 | ulimit -n $MAX_FD 100 | if [ $? -ne 0 ] ; then 101 | warn "Could not set maximum file descriptor limit: $MAX_FD" 102 | fi 103 | else 104 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 105 | fi 106 | fi 107 | 108 | # For Darwin, add options to specify how the application appears in the dock 109 | if $darwin; then 110 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 111 | fi 112 | 113 | # For Cygwin, switch paths to Windows format before running java 114 | if $cygwin ; then 115 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 116 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules 158 | function splitJvmOpts() { 159 | JVM_OPTS=("$@") 160 | } 161 | eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS 162 | JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" 163 | 164 | exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" 165 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 12 | set DEFAULT_JVM_OPTS= 13 | 14 | set DIRNAME=%~dp0 15 | if "%DIRNAME%" == "" set DIRNAME=. 16 | set APP_BASE_NAME=%~n0 17 | set APP_HOME=%DIRNAME% 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windowz variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | if "%@eval[2+2]" == "4" goto 4NT_args 53 | 54 | :win9xME_args 55 | @rem Slurp the command line arguments. 56 | set CMD_LINE_ARGS= 57 | set _SKIP=2 58 | 59 | :win9xME_args_slurp 60 | if "x%~1" == "x" goto execute 61 | 62 | set CMD_LINE_ARGS=%* 63 | goto execute 64 | 65 | :4NT_args 66 | @rem Get arguments from the 4NT Shell from JP Software 67 | set CMD_LINE_ARGS=%$ 68 | 69 | :execute 70 | @rem Setup the command line 71 | 72 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 73 | 74 | @rem Execute Gradle 75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 76 | 77 | :end 78 | @rem End local scope for the variables with windows NT shell 79 | if "%ERRORLEVEL%"=="0" goto mainEnd 80 | 81 | :fail 82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 83 | rem the _cmd.exe /c_ return code! 84 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 85 | exit /b 1 86 | 87 | :mainEnd 88 | if "%OS%"=="Windows_NT" endlocal 89 | 90 | :omega 91 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = 'spring-boot-swagger' 2 | -------------------------------------------------------------------------------- /src/main/java/springboot/swagger/ServletContextPathProvider.java: -------------------------------------------------------------------------------- 1 | package springboot.swagger; 2 | 3 | import com.mangofactory.swagger.core.SwaggerPathProvider; 4 | import org.springframework.web.util.UriComponentsBuilder; 5 | 6 | import javax.servlet.ServletContext; 7 | 8 | public class ServletContextPathProvider implements SwaggerPathProvider { 9 | 10 | private final SwaggerPathProvider swaggerPathProvider; 11 | 12 | private final ServletContext servletContext; 13 | 14 | public ServletContextPathProvider(SwaggerPathProvider swaggerPathProvider, ServletContext servletContext) { 15 | this.swaggerPathProvider = swaggerPathProvider; 16 | this.servletContext = servletContext; 17 | } 18 | 19 | @Override 20 | public String getApiResourcePrefix() { 21 | return swaggerPathProvider.getApiResourcePrefix(); 22 | } 23 | 24 | public String getAppBasePath() { 25 | return UriComponentsBuilder 26 | .fromHttpUrl("http://127.0.0.1:8080") 27 | .path(servletContext.getContextPath()) 28 | .build() 29 | .toString(); 30 | } 31 | 32 | @Override 33 | public String sanitizeRequestMappingPattern(String requestMappingPattern) { 34 | return swaggerPathProvider.sanitizeRequestMappingPattern(requestMappingPattern); 35 | } 36 | 37 | } 38 | -------------------------------------------------------------------------------- /src/main/java/springboot/swagger/SpringBootSwaggerConfig.java: -------------------------------------------------------------------------------- 1 | package springboot.swagger; 2 | 3 | import com.fasterxml.classmate.TypeResolver; 4 | import com.mangofactory.swagger.configuration.JacksonScalaSupport; 5 | import com.mangofactory.swagger.configuration.SpringSwaggerConfig; 6 | import com.mangofactory.swagger.configuration.SwaggerGlobalSettings; 7 | import com.mangofactory.swagger.core.SwaggerApiResourceListing; 8 | import com.mangofactory.swagger.core.SwaggerPathProvider; 9 | import com.mangofactory.swagger.models.alternates.AlternateTypeProvider; 10 | import com.mangofactory.swagger.models.alternates.WildcardType; 11 | import com.mangofactory.swagger.scanners.ApiListingReferenceScanner; 12 | import org.springframework.beans.factory.annotation.Autowired; 13 | import org.springframework.context.annotation.Bean; 14 | import org.springframework.context.annotation.Configuration; 15 | import org.springframework.http.HttpEntity; 16 | import org.springframework.http.ResponseEntity; 17 | import org.springframework.web.context.ServletContextAware; 18 | 19 | import javax.servlet.ServletContext; 20 | import java.util.List; 21 | 22 | import static com.mangofactory.swagger.models.alternates.Alternates.newRule; 23 | 24 | @Configuration 25 | public abstract class SpringBootSwaggerConfig implements ServletContextAware { 26 | 27 | @Autowired 28 | private SpringSwaggerConfig springSwaggerConfig; 29 | 30 | private ServletContext servletContext; 31 | 32 | @Override 33 | public void setServletContext(ServletContext servletContext) { 34 | this.servletContext = servletContext; 35 | } 36 | 37 | @Bean 38 | public JacksonScalaSupport jacksonScalaSupport() { 39 | JacksonScalaSupport jacksonScalaSupport = new JacksonScalaSupport(); 40 | jacksonScalaSupport.setRegisterScalaModule(true); 41 | return jacksonScalaSupport; 42 | } 43 | 44 | @Bean 45 | public SwaggerGlobalSettings swaggerGlobalSettings() { 46 | SwaggerGlobalSettings swaggerGlobalSettings = new SwaggerGlobalSettings(); 47 | swaggerGlobalSettings.setGlobalResponseMessages(springSwaggerConfig.defaultResponseMessages()); 48 | swaggerGlobalSettings.setIgnorableParameterTypes(springSwaggerConfig.defaultIgnorableParameterTypes()); 49 | AlternateTypeProvider alternateTypeProvider = springSwaggerConfig.defaultAlternateTypeProvider(); 50 | TypeResolver typeResolver = new TypeResolver(); 51 | alternateTypeProvider.addRule(newRule(typeResolver.resolve(ResponseEntity.class), 52 | typeResolver.resolve(Void.class))); 53 | alternateTypeProvider.addRule(newRule(typeResolver.resolve(ResponseEntity.class, WildcardType.class), 54 | typeResolver.resolve(WildcardType.class))); 55 | alternateTypeProvider.addRule(newRule(typeResolver.resolve(HttpEntity.class, WildcardType.class), 56 | typeResolver.resolve(WildcardType.class))); 57 | swaggerGlobalSettings.setAlternateTypeProvider(alternateTypeProvider); 58 | return swaggerGlobalSettings; 59 | } 60 | 61 | @Bean 62 | public SwaggerApiResourceListing swaggerApiResourceListing() { 63 | SwaggerApiResourceListing swaggerApiResourceListing = new SwaggerApiResourceListing(springSwaggerConfig.swaggerCache(), getSwaggerGroup()); 64 | swaggerApiResourceListing.setSwaggerGlobalSettings(swaggerGlobalSettings()); 65 | swaggerApiResourceListing.setSwaggerPathProvider(pathProvider()); 66 | swaggerApiResourceListing.setApiListingReferenceScanner(apiListingReferenceScanner()); 67 | return swaggerApiResourceListing; 68 | } 69 | 70 | @Bean 71 | public ApiListingReferenceScanner apiListingReferenceScanner() { 72 | ApiListingReferenceScanner apiListingReferenceScanner = new ApiListingReferenceScanner(); 73 | apiListingReferenceScanner.setRequestMappingHandlerMapping(springSwaggerConfig.swaggerRequestMappingHandlerMappings()); 74 | apiListingReferenceScanner.setExcludeAnnotations(springSwaggerConfig.defaultExcludeAnnotations()); 75 | apiListingReferenceScanner.setResourceGroupingStrategy(springSwaggerConfig.defaultResourceGroupingStrategy()); 76 | apiListingReferenceScanner.setSwaggerPathProvider(pathProvider()); 77 | apiListingReferenceScanner.setSwaggerGroup(getSwaggerGroup()); 78 | apiListingReferenceScanner.setIncludePatterns(getIncludePatterns()); 79 | return apiListingReferenceScanner; 80 | } 81 | 82 | @Bean 83 | public SwaggerPathProvider pathProvider() { 84 | return new ServletContextPathProvider(springSwaggerConfig.defaultSwaggerPathProvider(), servletContext); 85 | } 86 | 87 | protected abstract List getIncludePatterns(); 88 | 89 | protected abstract String getSwaggerGroup(); 90 | 91 | } 92 | -------------------------------------------------------------------------------- /src/test/java/springboot/swagger/SpringBootSwaggerTest.java: -------------------------------------------------------------------------------- 1 | package springboot.swagger; 2 | 3 | import com.mangofactory.swagger.configuration.SpringSwaggerConfig; 4 | import com.wordnik.swagger.annotations.Api; 5 | import com.wordnik.swagger.annotations.ApiOperation; 6 | import org.junit.Test; 7 | import org.junit.runner.RunWith; 8 | import org.springframework.boot.autoconfigure.EnableAutoConfiguration; 9 | import org.springframework.boot.test.IntegrationTest; 10 | import org.springframework.boot.test.SpringApplicationConfiguration; 11 | import org.springframework.context.annotation.Import; 12 | import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; 13 | import org.springframework.test.context.web.WebAppConfiguration; 14 | import org.springframework.web.bind.annotation.RequestMapping; 15 | import org.springframework.web.bind.annotation.RestController; 16 | 17 | import java.util.Arrays; 18 | import java.util.List; 19 | 20 | import static com.jayway.restassured.RestAssured.get; 21 | import static org.hamcrest.Matchers.equalTo; 22 | import static org.springframework.web.bind.annotation.RequestMethod.GET; 23 | 24 | @RunWith(SpringJUnit4ClassRunner.class) 25 | @SpringApplicationConfiguration(classes = { 26 | SpringBootSwaggerTest.SomeApplication.class, 27 | SpringBootSwaggerTest.SomeController.class, 28 | SpringBootSwaggerTest.SomeSwaggerConfig.class }) 29 | @WebAppConfiguration 30 | @IntegrationTest 31 | public class SpringBootSwaggerTest { 32 | 33 | @Test 34 | public void shouldReturnApiDocs() { 35 | get("http://localhost:8080/api-docs") 36 | .then() 37 | .body("apis.size()", equalTo(1)) 38 | .body("apis[0].path", equalTo("/test/some-controller")); 39 | } 40 | 41 | @Test 42 | public void shouldReturnEndpointDocs() { 43 | get("http://localhost:8080/api-docs/test/some-controller") 44 | .then() 45 | .body("resourcePath", equalTo("/some-controller")) 46 | .body("apis[0].operations.size()", equalTo(1)) 47 | .body("apis[0].operations[0].method", equalTo("GET")) 48 | .body("apis[0].operations[0].summary", equalTo("test operation")) 49 | .body("apis[0].operations[0].parameters.size()", equalTo(0)); 50 | } 51 | 52 | @EnableAutoConfiguration 53 | public static class SomeApplication { 54 | } 55 | 56 | @RestController 57 | @Api("my-controller") 58 | public static class SomeController { 59 | @ApiOperation("test operation") 60 | @RequestMapping(value = "/", method = GET) 61 | public String home() { 62 | return "Hello World!"; 63 | } 64 | } 65 | 66 | @Import(SpringSwaggerConfig.class) 67 | public static class SomeSwaggerConfig extends SpringBootSwaggerConfig { 68 | @Override 69 | protected List getIncludePatterns() { 70 | return Arrays.asList(".*"); 71 | } 72 | 73 | @Override 74 | protected String getSwaggerGroup() { 75 | return "test"; 76 | } 77 | } 78 | } 79 | --------------------------------------------------------------------------------