Skip to content

Commit c9c9505

Browse files
frantumafrantuma
authored
Merge pull request #8752 from swagger-api/ui-fix
fix ui and spec tags
2 parents ef51d6e + 4724d7d commit c9c9505

File tree

5 files changed

+177
-5
lines changed

5 files changed

+177
-5
lines changed

‎modules/swagger-generator/src/main/resources/openapi.yaml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ info:
1010
name: Apache 2.0
1111
url: http://www.apache.org/licenses/LICENSE-2.0.html
1212
tags:
13-
- name: developers
14-
description: Operations available to developers
1513
- name: clients
1614
- name: servers
1715
paths:
@@ -97,6 +95,9 @@ paths:
9795
type: string
9896
"/options":
9997
get:
98+
tags:
99+
- clients
100+
- servers
100101
x-swagger-router-controller: io.swagger.v3.generator.online.GeneratorController
101102
operationId: listOptions
102103
summary: Returns options for a given language (client or server)

‎modules/swagger-generator/src/main/webapp/WEB-INF/web.xml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,20 @@
1515
<servlet-name>default</servlet-name>
1616
<url-pattern>/ui/*</url-pattern>
1717
</servlet-mapping>
18+
<servlet-mapping>
19+
<servlet-name>default</servlet-name>
20+
<url-pattern>/index.html</url-pattern>
21+
</servlet-mapping>
22+
<servlet-mapping>
23+
<servlet-name>default</servlet-name>
24+
<url-pattern>/oauth2-redirect.html</url-pattern>
25+
</servlet-mapping>
1826
<servlet-mapping>
1927
<servlet-name>swagger-inflector</servlet-name>
2028
<url-pattern>/*</url-pattern>
2129
</servlet-mapping>
2230

31+
2332
<servlet>
2433
<servlet-name>DefaultServlet</servlet-name>
2534
<servlet-class>io.swagger.v3.generator.online.DefaultServlet</servlet-class>

‎modules/swagger-generator/src/main/webapp/index.html‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
<!-- HTML for static distribution bundle build -->
2+
<!DOCTYPE html>
3+
<html lang="en">
4+
<head>
5+
<meta charset="UTF-8">
6+
<title>Swagger UI</title>
7+
<link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700|Source+Code+Pro:300,600|Titillium+Web:400,600,700" rel="stylesheet">
8+
<link rel="stylesheet" type="text/css" href="./ui/swagger-ui.css" >
9+
<link rel="icon" type="image/png" href="./ui/favicon-32x32.png" sizes="32x32" />
10+
<link rel="icon" type="image/png" href="./ui/favicon-16x16.png" sizes="16x16" />
11+
<style>
12+
html
13+
{
14+
box-sizing: border-box;
15+
overflow: -moz-scrollbars-vertical;
16+
overflow-y: scroll;
17+
}
18+
*,
19+
*:before,
20+
*:after
21+
{
22+
box-sizing: inherit;
23+
}
24+
25+
body {
26+
margin:0;
27+
background: #fafafa;
28+
}
29+
</style>
30+
</head>
31+
32+
<body>
33+
34+
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="position:absolute;width:0;height:0">
35+
<defs>
36+
<symbol viewBox="0 0 20 20" id="unlocked">
37+
<path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V6h2v-.801C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8z"></path>
38+
</symbol>
39+
40+
<symbol viewBox="0 0 20 20" id="locked">
41+
<path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8zM12 8H8V5.199C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8z"/>
42+
</symbol>
43+
44+
<symbol viewBox="0 0 20 20" id="close">
45+
<path d="M14.348 14.849c-.469.469-1.229.469-1.697 0L10 11.819l-2.651 3.029c-.469.469-1.229.469-1.697 0-.469-.469-.469-1.229 0-1.697l2.758-3.15-2.759-3.152c-.469-.469-.469-1.228 0-1.697.469-.469 1.228-.469 1.697 0L10 8.183l2.651-3.031c.469-.469 1.228-.469 1.697 0 .469.469.469 1.229 0 1.697l-2.758 3.152 2.758 3.15c.469.469.469 1.229 0 1.698z"/>
46+
</symbol>
47+
48+
<symbol viewBox="0 0 20 20" id="large-arrow">
49+
<path d="M13.25 10L6.109 2.58c-.268-.27-.268-.707 0-.979.268-.27.701-.27.969 0l7.83 7.908c.268.271.268.709 0 .979l-7.83 7.908c-.268.271-.701.27-.969 0-.268-.269-.268-.707 0-.979L13.25 10z"/>
50+
</symbol>
51+
52+
<symbol viewBox="0 0 20 20" id="large-arrow-down">
53+
<path d="M17.418 6.109c.272-.268.709-.268.979 0s.271.701 0 .969l-7.908 7.83c-.27.268-.707.268-.979 0l-7.908-7.83c-.27-.268-.27-.701 0-.969.271-.268.709-.268.979 0L10 13.25l7.418-7.141z"/>
54+
</symbol>
55+
56+
57+
<symbol viewBox="0 0 24 24" id="jump-to">
58+
<path d="M19 7v4H5.83l3.58-3.59L8 6l-6 6 6 6 1.41-1.41L5.83 13H21V7z"/>
59+
</symbol>
60+
61+
<symbol viewBox="0 0 24 24" id="expand">
62+
<path d="M10 18h4v-2h-4v2zM3 6v2h18V6H3zm3 7h12v-2H6v2z"/>
63+
</symbol>
64+
65+
</defs>
66+
</svg>
67+
68+
<div id="swagger-ui"></div>
69+
70+
<script src="./ui/swagger-ui-bundle.js"> </script>
71+
<script src="./ui/swagger-ui-standalone-preset.js"> </script>
72+
<script>
73+
window.onload = function() {
74+
apiUrl = window.location.protocol + "//" + window.location.host + "/openapi.json";
75+
// Build a system
76+
const ui = SwaggerUIBundle({
77+
url: apiUrl,
78+
dom_id: '#swagger-ui',
79+
presets: [
80+
SwaggerUIBundle.presets.apis,
81+
SwaggerUIStandalonePreset
82+
],
83+
plugins: [
84+
SwaggerUIBundle.plugins.DownloadUrl
85+
],
86+
layout: "StandaloneLayout"
87+
})
88+
89+
window.ui = ui
90+
}
91+
</script>
92+
</body>
93+
94+
</html>

‎modules/swagger-generator/src/main/webapp/oauth2-redirect.html‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
<!doctype html>
2+
<html lang="en-US">
3+
<body onload="run()">
4+
</body>
5+
</html>
6+
<script>
7+
'use strict';
8+
function run () {
9+
var oauth2 = window.opener.swaggerUIRedirectOauth2;
10+
var sentState = oauth2.state;
11+
var redirectUrl = oauth2.redirectUrl;
12+
var isValid, qp, arr;
13+
14+
if (/code|token|error/.test(window.location.hash)) {
15+
qp = window.location.hash.substring(1);
16+
} else {
17+
qp = location.search.substring(1);
18+
}
19+
20+
arr = qp.split("&")
21+
arr.forEach(function (v,i,_arr) { _arr[i] = '"' + v.replace('=', '":"') + '"';})
22+
qp = qp ? JSON.parse('{' + arr.join() + '}',
23+
function (key, value) {
24+
return key === "" ? value : decodeURIComponent(value)
25+
}
26+
) : {}
27+
28+
isValid = qp.state === sentState
29+
30+
if ((
31+
oauth2.auth.schema.get("flow") === "accessCode"||
32+
oauth2.auth.schema.get("flow") === "authorizationCode"
33+
) && !oauth2.auth.code) {
34+
if (!isValid) {
35+
oauth2.errCb({
36+
authId: oauth2.auth.name,
37+
source: "auth",
38+
level: "warning",
39+
message: "Authorization may be unsafe, passed state was changed in server Passed state wasn't returned from auth server"
40+
});
41+
}
42+
43+
if (qp.code) {
44+
delete oauth2.state;
45+
oauth2.auth.code = qp.code;
46+
oauth2.callback({auth: oauth2.auth, redirectUrl: redirectUrl});
47+
} else {
48+
let oauthErrorMsg
49+
if (qp.error) {
50+
oauthErrorMsg = "["+qp.error+"]: " +
51+
(qp.error_description ? qp.error_description+ ". " : "no accessCode received from the server. ") +
52+
(qp.error_uri ? "More info: "+qp.error_uri : "");
53+
}
54+
55+
oauth2.errCb({
56+
authId: oauth2.auth.name,
57+
source: "auth",
58+
level: "error",
59+
message: oauthErrorMsg || "[Authorization failed]: no accessCode received from the server"
60+
});
61+
}
62+
} else {
63+
oauth2.callback({auth: oauth2.auth, token: qp, isValid: isValid, redirectUrl: redirectUrl});
64+
}
65+
window.close();
66+
}
67+
</script>

‎modules/swagger-generator/src/main/webapp/ui/index.html‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
<title>Swagger UI</title>
77
<link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700|Source+Code+Pro:300,600|Titillium+Web:400,600,700" rel="stylesheet">
88
<link rel="stylesheet" type="text/css" href="./swagger-ui.css" >
9-
<link rel="icon" type="image/png" href="../public/favicon-32x32.png" sizes="32x32" />
10-
<link rel="icon" type="image/png" href="../public/favicon-16x16.png" sizes="16x16" />
9+
<link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
10+
<link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
1111
<style>
1212
html
1313
{
@@ -71,9 +71,10 @@
7171
<script src="./swagger-ui-standalone-preset.js"> </script>
7272
<script>
7373
window.onload = function() {
74+
apiUrl = window.location.protocol + "//" + window.location.host + "/openapi.json";
7475
// Build a system
7576
const ui = SwaggerUIBundle({
76-
url: "/openapi.json",
77+
url: apiUrl,
7778
dom_id: '#swagger-ui',
7879
presets: [
7980
SwaggerUIBundle.presets.apis,

0 commit comments

Comments
 (0)