Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add resource discovery to swagger ui webjar
- Changing webjar layout to match the webjar standard - Added gitter/circleci integration
- Loading branch information
Showing
9 changed files
with
219 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <title>Swagger UI</title> | ||
| <link href='css/typography.css' media='screen' rel='stylesheet' type='text/css'/> | ||
| <link href='css/reset.css' media='screen' rel='stylesheet' type='text/css'/> | ||
| <link href='css/screen.css' media='screen' rel='stylesheet' type='text/css'/> | ||
| <link href='css/reset.css' media='print' rel='stylesheet' type='text/css'/> | ||
| <link href='css/screen.css' media='print' rel='stylesheet' type='text/css'/> | ||
| <script type="text/javascript" src="lib/shred.bundle.js"></script> | ||
| <script src='lib/jquery-1.8.0.min.js' type='text/javascript'></script> | ||
| <script src='lib/jquery.slideto.min.js' type='text/javascript'></script> | ||
| <script src='lib/jquery.wiggle.min.js' type='text/javascript'></script> | ||
| <script src='lib/jquery.ba-bbq.min.js' type='text/javascript'></script> | ||
| <script src='lib/handlebars-2.0.0.js' type='text/javascript'></script> | ||
| <script src='lib/underscore-min.js' type='text/javascript'></script> | ||
| <script src='lib/backbone-min.js' type='text/javascript'></script> | ||
| <script src='lib/swagger-client.js' type='text/javascript'></script> | ||
| <script src='swagger-ui.js' type='text/javascript'></script> | ||
| <script src='lib/highlight.7.3.pack.js' type='text/javascript'></script> | ||
| <script src='lib/marked.js' type='text/javascript'></script> | ||
|
|
||
| <!-- enabling this will enable oauth2 implicit scope support --> | ||
| <script src='lib/swagger-oauth.js' type='text/javascript'></script> | ||
| <script type="text/javascript"> | ||
| $(function () { | ||
| var url = window.location.search.match(/url=([^&]+)/); | ||
| if (url && url.length > 1) { | ||
| url = decodeURIComponent(url[1]); | ||
| } else { | ||
| url = window.location.origin + "${pageContext.request.contextPath}/api-docs"; | ||
| } | ||
| window.swaggerUi = new SwaggerUi({ | ||
| url: url, | ||
| dom_id: "swagger-ui-container", | ||
| supportedSubmitMethods: ['get', 'post', 'put', 'delete', 'patch'], | ||
| onComplete: function (swaggerApi, swaggerUi) { | ||
| if (typeof initOAuth == "function") { | ||
| initOAuth({ | ||
| clientId: "your-client-id", | ||
| realm: "your-realms", | ||
| appName: "your-app-name" | ||
| }); | ||
| } | ||
| $('pre code').each(function (i, e) { | ||
| hljs.highlightBlock(e) | ||
| }); | ||
| }, | ||
| onFailure: function (data) { | ||
| log("Unable to Load SwaggerUI"); | ||
| }, | ||
| docExpansion: "none", | ||
| sorter: "alpha" | ||
| }); | ||
| function addApiKeyAuthorization() { | ||
| var key = $('#input_apiKey')[0].value; | ||
| log("key: " + key); | ||
| if (key && key.trim() != "") { | ||
| log("added key " + key); | ||
| window.authorizations.add("api_key", new ApiKeyAuthorization("api_key", key, "query")); | ||
| } | ||
| } | ||
| $('#input_apiKey').change(function () { | ||
| addApiKeyAuthorization(); | ||
| }); | ||
| var apiKey = "myApiKeyXXXX123456789"; | ||
| $('#input_apiKey').val(apiKey); | ||
| addApiKeyAuthorization(); | ||
| window.swaggerUi.load(); | ||
| }); | ||
| </script> | ||
| </head> | ||
|
|
||
| <body class="swagger-section"> | ||
| <div id='header'> | ||
| <div class="swagger-ui-wrap"> | ||
| <a id="logo" href="http://swagger.io">swagger</a> | ||
|
|
||
| <form id='api_selector'> | ||
| <div class='input'><input placeholder="http://example.com/api" id="input_baseUrl" name="baseUrl" type="text"/></div> | ||
| <div class='input'><input placeholder="api_key" id="input_apiKey" name="apiKey" type="text"/></div> | ||
| <div class='input'><a id="explore" href="#">Explore</a></div> | ||
| </form> | ||
| </div> | ||
| <div> | ||
| <jsp:include page="swaggerResources.jsp"/> | ||
| </div> | ||
| </div> | ||
|
|
||
| <div id="message-bar" class="swagger-ui-wrap"> </div> | ||
| <div id="swagger-ui-container" class="swagger-ui-wrap"></div> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| <%@ page import="org.springframework.context.ApplicationContext" %> | ||
| <%@ page import="org.springframework.web.context.support.WebApplicationContextUtils" %> | ||
| <%@ page import="springfox.documentation.swagger.ui.ApiResourceLocator" %> | ||
| <%@ page import="springfox.documentation.swagger.ui.SwaggerApi" %> | ||
| <ol> | ||
| <% | ||
| ApplicationContext context = WebApplicationContextUtils.getWebApplicationContext(request.getServletContext()); | ||
| ApiResourceLocator apiResourceLocator = (ApiResourceLocator) context.getBean("apiResourceLocator"); | ||
| for (SwaggerApi swaggerApi : apiResourceLocator.resources()) { | ||
| %> | ||
| <li> | ||
| <%=swaggerApi.getTitle() + "-" + swaggerApi.getUri()%> | ||
| </li> | ||
|
|
||
| <% | ||
| } | ||
| %> | ||
| </ol> |
48 changes: 48 additions & 0 deletions
48
...ngfox-swagger-ui/src/main/java/springfox/documentation/swagger/ui/ApiResourceLocator.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| /* | ||
| * | ||
| * Copyright 2015 the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| * | ||
| */ | ||
| package springfox.documentation.swagger.ui; | ||
|
|
||
| import org.springframework.beans.factory.annotation.Autowired; | ||
| import org.springframework.stereotype.Component; | ||
| import springfox.documentation.service.Documentation; | ||
| import springfox.documentation.spring.web.DocumentationCache; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
|
|
||
| @Component | ||
| public class ApiResourceLocator { | ||
|
|
||
| private final DocumentationCache documentationCache; | ||
|
|
||
| @Autowired | ||
| public ApiResourceLocator(DocumentationCache documentationCache) { | ||
| this.documentationCache = documentationCache; | ||
| } | ||
|
|
||
| public List<SwaggerApi> resources() { | ||
| List<SwaggerApi> swaggerApis = new ArrayList<SwaggerApi>(); | ||
| for (Documentation documentation : documentationCache.all()) { | ||
| SwaggerApi swaggerApi = new SwaggerApi(); | ||
| swaggerApi.setUri(documentation.getBasePath()); | ||
| swaggerApi.setTitle(documentation.getGroupName()); | ||
| } | ||
| return swaggerApis; | ||
| } | ||
| } |
40 changes: 40 additions & 0 deletions
40
springfox-swagger-ui/src/main/java/springfox/documentation/swagger/ui/SwaggerApi.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| /* | ||
| * | ||
| * Copyright 2015 the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| * | ||
| */ | ||
| package springfox.documentation.swagger.ui; | ||
|
|
||
| public class SwaggerApi { | ||
| private String uri; | ||
| private String title; | ||
|
|
||
| public String getUri() { | ||
| return uri; | ||
| } | ||
|
|
||
| public void setUri(String uri) { | ||
| this.uri = uri; | ||
| } | ||
|
|
||
| public String getTitle() { | ||
| return title; | ||
| } | ||
|
|
||
| public void setTitle(String title) { | ||
| this.title = title; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters