├── .gitignore ├── LICENSE ├── README.md ├── build.gradle ├── gradle ├── publishing.gradle └── wrapper │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── settings.gradle └── src ├── main └── java │ └── springfox │ └── documentation │ └── swaggerui │ └── .gitkeep └── web ├── fonts ├── DroidSans-Bold.ttf └── DroidSans.ttf ├── js └── springfox.js └── swagger-ui.html /.gitignore: -------------------------------------------------------------------------------- 1 | *.class 2 | 3 | # Mobile Tools for Java (J2ME) 4 | .mtj.tmp/ 5 | 6 | # Package Files # 7 | *.jar 8 | *.war 9 | *.ear 10 | 11 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 12 | hs_err_pid* 13 | build 14 | .gradle 15 | .DS_Store 16 | .idea/ 17 | springfox-swagger-ui.iml 18 | -------------------------------------------------------------------------------- /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. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ##### springfox-swagger-ui 2 | 3 | - Creates a webjar containing the swagger-ui static content. 4 | - Adds a JSON endpoint `/swagger-resources` which lists all of the swagger resources and versions configured for a given 5 | application. 6 | 7 | Prior versions of this library included sdoc.jsp which caused all kinds of problems on 8 | spring boot. This latest version now bundles a html (swagger-ui.html) instead. 9 | 10 | The swagger ui version is specified in ./build.gradle where `swaggerUiVersion` is a git tag on the [swagger-ui repo] 11 | (https://github.com/swagger-api/swagger-ui). 12 | 13 | - All content is served from a webjar convention, relative url taking the following form: 14 | `webjars/${project.name}/${project.version}` e.g: `/webjars/springfox-swagger-ui//swagger-ui 15 | .html` 16 | 17 | By default Spring Boot has sensible defaults for serving content from webjars. To configure vanilla spring web mvc apps to serve 18 | webjar content see the [webjar documentation] (http://www.webjars.org/documentation#springmvc) 19 | 20 | ##### Releasing swagger-ui 21 | 22 | ```bash 23 | ./gradlew clean build bintrayUpload -PbintrayUsername= -PbintrayApiKey= -PossUser= -PossPassword= 24 | ``` -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | buildscript { 18 | repositories { 19 | jcenter() 20 | mavenCentral() 21 | } 22 | dependencies { 23 | classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.2' 24 | } 25 | 26 | } 27 | 28 | plugins { 29 | id "de.undercouch.download" version "3.1.0" 30 | } 31 | 32 | description = 'A swagger-ui mod that supports rfc6570 compliant urls' 33 | group = 'io.springfox.ui' 34 | version = '1.0.1-SNAPSHOT' 35 | 36 | apply plugin: 'java' 37 | apply plugin: 'idea' 38 | apply plugin: 'maven-publish' 39 | apply plugin: 'com.jfrog.bintray' 40 | apply from: 'gradle/publishing.gradle' 41 | 42 | ext { 43 | swaggerUiVersion = '2.2.6-rfc6570' 44 | swaggerUiDist = "build/libs/swagger-ui-dist.zip" 45 | swaggerUiExplodedDir = "swagger-ui-${swaggerUiVersion}/dist/" 46 | downloadUrl = "https://github.com/dilipkrish/swagger-ui/archive/v${swaggerUiVersion}.zip" 47 | destinationZip = "$buildDir/zip/${swaggerUiVersion}.zip" 48 | replacePath = 'window.location.origin + "\\${pageContext.request.contextPath}/api-docs"' 49 | artifactRepoBase = 'http://oss.jfrog.org/artifactory' 50 | } 51 | 52 | task wrapper(type: Wrapper) { 53 | gradleVersion = '2.10' 54 | } 55 | 56 | task swaggerUiDownload << { 57 | if (!file(destinationZip)?.exists()) { 58 | download { 59 | src downloadUrl 60 | dest destinationZip 61 | onlyIfNewer true 62 | } 63 | } 64 | } 65 | 66 | task unzip(type: Copy) { 67 | from zipTree(file(destinationZip)) 68 | include "*/dist/**" 69 | into file("${buildDir}") 70 | } 71 | 72 | task customizeSwaggerUi << { 73 | copy { 74 | from("${projectDir}/src/web/js/springfox.js") 75 | into("${buildDir}/${swaggerUiExplodedDir}") 76 | } 77 | copy { 78 | from("${projectDir}/src/web/fonts") 79 | into("${buildDir}/${swaggerUiExplodedDir}/fonts") 80 | } 81 | delete "${buildDir}/${swaggerUiExplodedDir}/index.html" 82 | delete "${buildDir}/${swaggerUiExplodedDir}/swagger-ui.js" 83 | } 84 | 85 | task sourcesJar(type: Jar, dependsOn: classes) { 86 | classifier = 'sources' 87 | from sourceSets.main.allSource 88 | } 89 | 90 | task javadocJar(type: Jar, dependsOn: javadoc) { 91 | classifier = 'javadoc' 92 | from javadoc.destinationDir 93 | } 94 | 95 | jar { 96 | 97 | from("${projectDir}/src/web/swagger-ui.html") { 98 | into "META-INF/resources" 99 | } 100 | 101 | from("${buildDir}/${swaggerUiExplodedDir}") { 102 | into "META-INF/resources/webjars/springfox-swagger-ui" 103 | manifest { 104 | attributes( 105 | 'Built-By': 'Dilip Krishnan', 106 | 'Created-By': System.properties['java.version'] + " (" + System.properties['java.vendor'] + " " + System.properties['java.vm.version'] + ")", 107 | 'Build-Date': project.buildDate, 108 | 'Build-Time': project.buildTime, 109 | 'Specification-Title': project.name, 110 | 'Specification-Version': project.version, 111 | 'Implementation-Title': project.name, 112 | 'Implementation-Version': project.version, 113 | "SwaggerUi-Version": swaggerUiVersion, 114 | ) 115 | } 116 | } 117 | } 118 | 119 | task cleanup(type: Delete) { 120 | delete "${buildDir}/${swaggerUiExplodedDir}" 121 | } 122 | 123 | clean.dependsOn(cleanup) 124 | compileJava.dependsOn(customizeSwaggerUi) 125 | customizeSwaggerUi.dependsOn(unzip) 126 | unzip.dependsOn(swaggerUiDownload) 127 | -------------------------------------------------------------------------------- /gradle/publishing.gradle: -------------------------------------------------------------------------------- 1 | import java.text.SimpleDateFormat 2 | 3 | Date buildTimeAndDate = new Date() 4 | ext { 5 | buildDate = new SimpleDateFormat('yyyy-MM-dd').format(buildTimeAndDate) 6 | buildTime = new SimpleDateFormat('HH:mm:ss.SSSZ').format(buildTimeAndDate) 7 | } 8 | 9 | if (!project.hasProperty('bintrayUsername')) ext.bintrayUsername = '' 10 | if (!project.hasProperty('bintrayApiKey')) ext.bintrayApiKey = '' 11 | if (!project.hasProperty('gpgPassphrase')) ext.gpgPassphrase = '' 12 | if (!project.hasProperty('ossUser')) ext.ossUser = '' 13 | if (!project.hasProperty('ossPassword')) ext.ossPassword = '' 14 | 15 | bintray { 16 | user = project.bintrayUsername 17 | key = project.bintrayApiKey 18 | dryRun = false //Whether to run this as dry-run, without deploying 19 | publish = true //If version should be auto published after an upload 20 | publications = ['mavenJava'] 21 | pkg { 22 | repo = 'maven-repo' 23 | userOrg = 'springfox' //An optional organization name when the repo belongs to one of the user's orgs 24 | name = 'springfox-swagger-ui' 25 | websiteUrl = 'https://github.com/springfox/springfox-swagger-ui-rfc6570' 26 | issueTrackerUrl = 'https://github.com/springfox/springfox-swagger-ui-rfc6570/issues' 27 | vcsUrl = 'https://github.com/springfox/springfox-swagger-ui-rfc6570/springfox-swagger-ui-rfc6570.git' 28 | desc = 'A swagger-ui mod that supports rfc6570 compliant urls' 29 | licenses = ['Apache-2.0'] 30 | labels = ['spring', 'swagger', 'apis', 'swagger-ui'] 31 | publicDownloadNumbers = true 32 | 33 | version { 34 | vcsTag = project.version 35 | gpg { 36 | sign = false //Determines whether to GPG sign the files. The default is false 37 | passphrase = project.gpgPassphrase //Optional. The passphrase for GPG signing' 38 | } 39 | mavenCentralSync { 40 | sync = false //Optional (true by default). Determines whether to sync the version to Maven Central. 41 | user = ossUser //OSS user token 42 | password = ossPassword //OSS user password 43 | } 44 | } 45 | } 46 | } 47 | 48 | publishing { 49 | publications { 50 | mavenJava(MavenPublication) { 51 | from components.java 52 | pom.withXml { 53 | def devs = ['dilipkrish': 'Dilip Krishnan'] 54 | def root = asNode() 55 | 56 | root.dependencies.'*'.findAll() { 57 | it.scope.text() == 'runtime' && project.configurations.compile.allDependencies.find { dep -> 58 | dep.name == it.artifactId.text() 59 | } 60 | }.each() { 61 | it.scope*.value = 'compile' 62 | } 63 | 64 | root.appendNode('name', 'springfox-swagger-ui-rfc6570') 65 | root.appendNode('packaging', 'jar') 66 | root.appendNode('url', 'https://github.com/springfox/springfox-swagger-ui-rfc6570') 67 | root.appendNode('description', 'A swagger-ui mod that supports rfc6570 compliant urls') 68 | 69 | def license = root.appendNode('licenses').appendNode('license') 70 | license.appendNode('name', 'Apache-2.0') 71 | license.appendNode('url', 'https://github.com/springfox/springfox-swagger-ui-rfc6570/blob/master/LICENSE.txt') 72 | license.appendNode('distribution', 'repo') 73 | 74 | root.appendNode('scm').appendNode('url', 'https://github.com/springfox/springfox-swagger-ui-rfc6570/springfox-swagger-ui-rfc6570.git') 75 | 76 | def developers = root.appendNode('developers') 77 | devs.each { 78 | def d = developers.appendNode('developer') 79 | d.appendNode('id', it.key) 80 | d.appendNode('name', it.value) 81 | } 82 | } 83 | artifact sourcesJar 84 | artifact javadocJar 85 | } 86 | } 87 | } 88 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Thu Jul 14 09:01:10 IST 2016 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-2.14-bin.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 | # Attempt to set APP_HOME 46 | # Resolve links: $0 may be a link 47 | PRG="$0" 48 | # Need this for relative symlinks. 49 | while [ -h "$PRG" ] ; do 50 | ls=`ls -ld "$PRG"` 51 | link=`expr "$ls" : '.*-> \(.*\)$'` 52 | if expr "$link" : '/.*' > /dev/null; then 53 | PRG="$link" 54 | else 55 | PRG=`dirname "$PRG"`"/$link" 56 | fi 57 | done 58 | SAVED="`pwd`" 59 | cd "`dirname \"$PRG\"`/" >/dev/null 60 | APP_HOME="`pwd -P`" 61 | cd "$SAVED" >/dev/null 62 | 63 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 64 | 65 | # Determine the Java command to use to start the JVM. 66 | if [ -n "$JAVA_HOME" ] ; then 67 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 68 | # IBM's JDK on AIX uses strange locations for the executables 69 | JAVACMD="$JAVA_HOME/jre/sh/java" 70 | else 71 | JAVACMD="$JAVA_HOME/bin/java" 72 | fi 73 | if [ ! -x "$JAVACMD" ] ; then 74 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 75 | 76 | Please set the JAVA_HOME variable in your environment to match the 77 | location of your Java installation." 78 | fi 79 | else 80 | JAVACMD="java" 81 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 82 | 83 | Please set the JAVA_HOME variable in your environment to match the 84 | location of your Java installation." 85 | fi 86 | 87 | # Increase the maximum file descriptors if we can. 88 | if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then 89 | MAX_FD_LIMIT=`ulimit -H -n` 90 | if [ $? -eq 0 ] ; then 91 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 92 | MAX_FD="$MAX_FD_LIMIT" 93 | fi 94 | ulimit -n $MAX_FD 95 | if [ $? -ne 0 ] ; then 96 | warn "Could not set maximum file descriptor limit: $MAX_FD" 97 | fi 98 | else 99 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 100 | fi 101 | fi 102 | 103 | # For Darwin, add options to specify how the application appears in the dock 104 | if $darwin; then 105 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 106 | fi 107 | 108 | # For Cygwin, switch paths to Windows format before running java 109 | if $cygwin ; then 110 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 111 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 112 | JAVACMD=`cygpath --unix "$JAVACMD"` 113 | 114 | # We build the pattern for arguments to be converted via cygpath 115 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 116 | SEP="" 117 | for dir in $ROOTDIRSRAW ; do 118 | ROOTDIRS="$ROOTDIRS$SEP$dir" 119 | SEP="|" 120 | done 121 | OURCYGPATTERN="(^($ROOTDIRS))" 122 | # Add a user-defined pattern to the cygpath arguments 123 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 124 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 125 | fi 126 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 127 | i=0 128 | for arg in "$@" ; do 129 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 130 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 131 | 132 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 133 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 134 | else 135 | eval `echo args$i`="\"$arg\"" 136 | fi 137 | i=$((i+1)) 138 | done 139 | case $i in 140 | (0) set -- ;; 141 | (1) set -- "$args0" ;; 142 | (2) set -- "$args0" "$args1" ;; 143 | (3) set -- "$args0" "$args1" "$args2" ;; 144 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 145 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 146 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 147 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 148 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 149 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 150 | esac 151 | fi 152 | 153 | # Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules 154 | function splitJvmOpts() { 155 | JVM_OPTS=("$@") 156 | } 157 | eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS 158 | JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" 159 | 160 | exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" 161 | -------------------------------------------------------------------------------- /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 | /* 2 | * This settings file was auto generated by the Gradle buildInit task 3 | * by 'd_krishnan' at '1/4/16 10:43 AM' with Gradle 2.10 4 | * 5 | * The settings file is used to specify which projects to include in your build. 6 | * In a single project build this file can be empty or even removed. 7 | * 8 | * Detailed information about configuring a multi-project build in Gradle can be found 9 | * in the user guide at https://docs.gradle.org/2.10/userguide/multi_project_builds.html 10 | */ 11 | 12 | /* 13 | // To declare projects as part of a multi-project build use the 'include' method 14 | include 'shared' 15 | include 'api' 16 | include 'services:webservice' 17 | */ 18 | 19 | rootProject.name = 'springfox-swagger-ui-rfc6570' 20 | -------------------------------------------------------------------------------- /src/main/java/springfox/documentation/swaggerui/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/springfox/springfox-swagger-ui-rfc6570/7324b970c52b4d1f2922cb1e97ccf2d4fb809313/src/main/java/springfox/documentation/swaggerui/.gitkeep -------------------------------------------------------------------------------- /src/web/fonts/DroidSans-Bold.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/springfox/springfox-swagger-ui-rfc6570/7324b970c52b4d1f2922cb1e97ccf2d4fb809313/src/web/fonts/DroidSans-Bold.ttf -------------------------------------------------------------------------------- /src/web/fonts/DroidSans.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/springfox/springfox-swagger-ui-rfc6570/7324b970c52b4d1f2922cb1e97ccf2d4fb809313/src/web/fonts/DroidSans.ttf -------------------------------------------------------------------------------- /src/web/js/springfox.js: -------------------------------------------------------------------------------- 1 | $(function() { 2 | var springfox = { 3 | "baseUrl": function() { 4 | var urlMatches = /(.*)\/swagger-ui.html.*/.exec(window.location.href); 5 | return urlMatches[1]; 6 | }, 7 | "securityConfig": function(cb) { 8 | $.getJSON(this.baseUrl() + "/swagger-resources/configuration/security", function(data) { 9 | cb(data); 10 | }); 11 | }, 12 | "uiConfig": function(cb) { 13 | $.getJSON(this.baseUrl() + "/swagger-resources/configuration/ui", function(data) { 14 | cb(data); 15 | }); 16 | } 17 | }; 18 | window.springfox = springfox; 19 | window.oAuthRedirectUrl = springfox.baseUrl() + '/webjars/springfox-swagger-ui/o2c.html'; 20 | 21 | window.springfox.uiConfig(function(data) { 22 | window.swaggerUi = new SwaggerUi({ 23 | dom_id: "swagger-ui-container", 24 | validatorUrl: data.validatorUrl, 25 | supportedSubmitMethods: data.supportedSubmitMethods || ['get', 'post', 'put', 'delete', 'patch'], 26 | onComplete: function(swaggerApi, swaggerUi) { 27 | 28 | initializeSpringfox(); 29 | 30 | if (window.SwaggerTranslator) { 31 | window.SwaggerTranslator.translate(); 32 | } 33 | 34 | $('pre code').each(function(i, e) { 35 | hljs.highlightBlock(e) 36 | }); 37 | 38 | }, 39 | onFailure: function(data) { 40 | log("Unable to Load SwaggerUI"); 41 | }, 42 | docExpansion: data.docExpansion || 'none', 43 | jsonEditor: JSON.parse(data.jsonEditor) || false, 44 | apisSorter: data.apisSorter || 'alpha', 45 | defaultModelRendering: data.defaultModelRendering || 'schema', 46 | showRequestHeaders: data.showRequestHeaders || true 47 | }); 48 | 49 | initializeBaseUrl(); 50 | 51 | function addApiKeyAuthorization(security) { 52 | var apiKeyVehicle = security.apiKeyVehicle || 'query'; 53 | var apiKeyName = security.apiKeyName || 'api_key'; 54 | var apiKey = security.apiKey || ''; 55 | if (apiKey && apiKey.trim() != "") { 56 | var apiKeyAuth = new SwaggerClient.ApiKeyAuthorization(apiKeyName, apiKey, apiKeyVehicle); 57 | window.swaggerUi.api.clientAuthorizations.add(apiKeyName, apiKeyAuth); 58 | log("added key " + apiKey); 59 | } 60 | } 61 | 62 | function log() { 63 | if ('console' in window) { 64 | console.log.apply(console, arguments); 65 | } 66 | } 67 | 68 | function oAuthIsDefined(security) { 69 | return security.clientId 70 | && security.clientSecret 71 | && security.appName 72 | && security.realm; 73 | } 74 | 75 | function initializeSpringfox() { 76 | var security = {}; 77 | window.springfox.securityConfig(function(data) { 78 | security = data; 79 | addApiKeyAuthorization(security); 80 | if (typeof initOAuth == "function" && oAuthIsDefined(security)) { 81 | initOAuth(security); 82 | } 83 | }); 84 | } 85 | }); 86 | 87 | $('#select_baseUrl').change(function() { 88 | window.swaggerUi.headerView.trigger('update-swagger-ui', { 89 | url: $('#select_baseUrl').val() 90 | }); 91 | }); 92 | 93 | function maybePrefix(location, withRelativePath) { 94 | var pat = /^https?:\/\//i; 95 | if (pat.test(location)) { 96 | return location; 97 | } 98 | return withRelativePath + location; 99 | } 100 | 101 | function initializeBaseUrl() { 102 | var relativeLocation = springfox.baseUrl(); 103 | 104 | $('#input_baseUrl').hide(); 105 | 106 | $.getJSON(relativeLocation + "/swagger-resources", function(data) { 107 | 108 | var $urlDropdown = $('#select_baseUrl'); 109 | $urlDropdown.empty(); 110 | $.each(data, function(i, resource) { 111 | var option = $('') 112 | .attr("value", maybePrefix(resource.location, relativeLocation)) 113 | .text(resource.name + " (" + resource.location + ")"); 114 | $urlDropdown.append(option); 115 | }); 116 | $urlDropdown.change(); 117 | }); 118 | 119 | } 120 | 121 | }); 122 | 123 | 124 | -------------------------------------------------------------------------------- /src/web/swagger-ui.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Swagger UI 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 47 | 48 |
 
49 |
50 | 51 | 52 | --------------------------------------------------------------------------------