mirror of
https://github.com/cool-team-official/cool-admin-midway.git
synced 2025-12-11 00:22:49 +00:00
集成swagger,优化部分内容
This commit is contained in:
parent
139b6b1063
commit
b2ed3f44d6
1
lock/base.sql.lock
Normal file
1
lock/base.sql.lock
Normal file
@ -0,0 +1 @@
|
||||
time consuming:1s
|
||||
1
lock/cloud.sql.lock
Normal file
1
lock/cloud.sql.lock
Normal file
@ -0,0 +1 @@
|
||||
time consuming:0s
|
||||
1
lock/dict.sql.lock
Normal file
1
lock/dict.sql.lock
Normal file
@ -0,0 +1 @@
|
||||
time consuming:0s
|
||||
1
lock/recycle.sql.lock
Normal file
1
lock/recycle.sql.lock
Normal file
@ -0,0 +1 @@
|
||||
time consuming:0s
|
||||
1
lock/task.sql.lock
Normal file
1
lock/task.sql.lock
Normal file
@ -0,0 +1 @@
|
||||
time consuming:0s
|
||||
@ -6,7 +6,7 @@
|
||||
"dependencies": {
|
||||
"@cool-midway/cache-manager-fs-hash": "^7.0.0",
|
||||
"@cool-midway/cloud": "^7.0.0",
|
||||
"@cool-midway/core": "^7.0.0",
|
||||
"@cool-midway/core": "D:\\src\\cool\\admin\\cool-admin-midway-packages\\core\\dist",
|
||||
"@cool-midway/file": "^7.0.0",
|
||||
"@cool-midway/iot": "^7.0.0",
|
||||
"@cool-midway/pay": "^7.0.0",
|
||||
|
||||
202
public/swagger/LICENSE
Normal file
202
public/swagger/LICENSE
Normal file
@ -0,0 +1,202 @@
|
||||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
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.
|
||||
2
public/swagger/NOTICE
Normal file
2
public/swagger/NOTICE
Normal file
@ -0,0 +1,2 @@
|
||||
swagger-ui
|
||||
Copyright 2020-2021 SmartBear Software Inc.
|
||||
22
public/swagger/README.md
Normal file
22
public/swagger/README.md
Normal file
@ -0,0 +1,22 @@
|
||||
# Swagger UI Dist
|
||||
[](http://badge.fury.io/js/swagger-ui-dist)
|
||||
|
||||
# API
|
||||
|
||||
This module, `swagger-ui-dist`, exposes Swagger-UI's entire dist folder as a dependency-free npm module.
|
||||
Use `swagger-ui` instead, if you'd like to have npm install dependencies for you.
|
||||
|
||||
`SwaggerUIBundle` and `SwaggerUIStandalonePreset` can be imported:
|
||||
```javascript
|
||||
import { SwaggerUIBundle, SwaggerUIStandalonePreset } from "swagger-ui-dist"
|
||||
```
|
||||
|
||||
To get an absolute path to this directory for static file serving, use the exported `getAbsoluteFSPath` method:
|
||||
|
||||
```javascript
|
||||
const swaggerUiAssetPath = require("swagger-ui-dist").getAbsoluteFSPath()
|
||||
|
||||
// then instantiate server that serves files from the swaggerUiAssetPath
|
||||
```
|
||||
|
||||
For anything else, check the [Swagger-UI](https://github.com/swagger-api/swagger-ui) repository.
|
||||
14
public/swagger/absolute-path.js
Normal file
14
public/swagger/absolute-path.js
Normal file
@ -0,0 +1,14 @@
|
||||
/*
|
||||
* getAbsoluteFSPath
|
||||
* @return {string} When run in NodeJS env, returns the absolute path to the current directory
|
||||
* When run outside of NodeJS, will return an error message
|
||||
*/
|
||||
const getAbsoluteFSPath = function () {
|
||||
// detect whether we are running in a browser or nodejs
|
||||
if (typeof module !== "undefined" && module.exports) {
|
||||
return require("path").resolve(__dirname)
|
||||
}
|
||||
throw new Error('getAbsoluteFSPath can only be called within a Nodejs environment');
|
||||
}
|
||||
|
||||
module.exports = getAbsoluteFSPath
|
||||
BIN
public/swagger/favicon-16x16.png
Normal file
BIN
public/swagger/favicon-16x16.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 665 B |
BIN
public/swagger/favicon-32x32.png
Normal file
BIN
public/swagger/favicon-32x32.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 628 B |
16
public/swagger/index.css
Normal file
16
public/swagger/index.css
Normal file
@ -0,0 +1,16 @@
|
||||
html {
|
||||
box-sizing: border-box;
|
||||
overflow: -moz-scrollbars-vertical;
|
||||
overflow-y: scroll;
|
||||
}
|
||||
|
||||
*,
|
||||
*:before,
|
||||
*:after {
|
||||
box-sizing: inherit;
|
||||
}
|
||||
|
||||
body {
|
||||
margin: 0;
|
||||
background: #fafafa;
|
||||
}
|
||||
19
public/swagger/index.html
Normal file
19
public/swagger/index.html
Normal file
@ -0,0 +1,19 @@
|
||||
<!-- HTML for static distribution bundle build -->
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<title>Swagger UI</title>
|
||||
<link rel="stylesheet" type="text/css" href="./swagger-ui.css" />
|
||||
<link rel="stylesheet" type="text/css" href="index.css" />
|
||||
<link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
|
||||
<link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<div id="swagger-ui"></div>
|
||||
<script src="./swagger-ui-bundle.js" charset="UTF-8"> </script>
|
||||
<script src="./swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
|
||||
<script src="./swagger-initializer.js" charset="UTF-8"> </script>
|
||||
</body>
|
||||
</html>
|
||||
17
public/swagger/index.js
Normal file
17
public/swagger/index.js
Normal file
@ -0,0 +1,17 @@
|
||||
try {
|
||||
module.exports.SwaggerUIBundle = require("./swagger-ui-bundle.js")
|
||||
module.exports.SwaggerUIStandalonePreset = require("./swagger-ui-standalone-preset.js")
|
||||
} catch(e) {
|
||||
// swallow the error if there's a problem loading the assets.
|
||||
// allows this module to support providing the assets for browserish contexts,
|
||||
// without exploding in a Node context.
|
||||
//
|
||||
// see https://github.com/swagger-api/swagger-ui/issues/3291#issuecomment-311195388
|
||||
// for more information.
|
||||
}
|
||||
|
||||
// `absolutePath` and `getAbsoluteFSPath` are both here because at one point,
|
||||
// we documented having one and actually implemented the other.
|
||||
// They were both retained so we don't break anyone's code.
|
||||
module.exports.absolutePath = require("./absolute-path.js")
|
||||
module.exports.getAbsoluteFSPath = require("./absolute-path.js")
|
||||
79
public/swagger/oauth2-redirect.html
Normal file
79
public/swagger/oauth2-redirect.html
Normal file
@ -0,0 +1,79 @@
|
||||
<!doctype html>
|
||||
<html lang="en-US">
|
||||
<head>
|
||||
<title>Swagger UI: OAuth2 Redirect</title>
|
||||
</head>
|
||||
<body>
|
||||
<script>
|
||||
'use strict';
|
||||
function run () {
|
||||
var oauth2 = window.opener.swaggerUIRedirectOauth2;
|
||||
var sentState = oauth2.state;
|
||||
var redirectUrl = oauth2.redirectUrl;
|
||||
var isValid, qp, arr;
|
||||
|
||||
if (/code|token|error/.test(window.location.hash)) {
|
||||
qp = window.location.hash.substring(1).replace('?', '&');
|
||||
} else {
|
||||
qp = location.search.substring(1);
|
||||
}
|
||||
|
||||
arr = qp.split("&");
|
||||
arr.forEach(function (v,i,_arr) { _arr[i] = '"' + v.replace('=', '":"') + '"';});
|
||||
qp = qp ? JSON.parse('{' + arr.join() + '}',
|
||||
function (key, value) {
|
||||
return key === "" ? value : decodeURIComponent(value);
|
||||
}
|
||||
) : {};
|
||||
|
||||
isValid = qp.state === sentState;
|
||||
|
||||
if ((
|
||||
oauth2.auth.schema.get("flow") === "accessCode" ||
|
||||
oauth2.auth.schema.get("flow") === "authorizationCode" ||
|
||||
oauth2.auth.schema.get("flow") === "authorization_code"
|
||||
) && !oauth2.auth.code) {
|
||||
if (!isValid) {
|
||||
oauth2.errCb({
|
||||
authId: oauth2.auth.name,
|
||||
source: "auth",
|
||||
level: "warning",
|
||||
message: "Authorization may be unsafe, passed state was changed in server. The passed state wasn't returned from auth server."
|
||||
});
|
||||
}
|
||||
|
||||
if (qp.code) {
|
||||
delete oauth2.state;
|
||||
oauth2.auth.code = qp.code;
|
||||
oauth2.callback({auth: oauth2.auth, redirectUrl: redirectUrl});
|
||||
} else {
|
||||
let oauthErrorMsg;
|
||||
if (qp.error) {
|
||||
oauthErrorMsg = "["+qp.error+"]: " +
|
||||
(qp.error_description ? qp.error_description+ ". " : "no accessCode received from the server. ") +
|
||||
(qp.error_uri ? "More info: "+qp.error_uri : "");
|
||||
}
|
||||
|
||||
oauth2.errCb({
|
||||
authId: oauth2.auth.name,
|
||||
source: "auth",
|
||||
level: "error",
|
||||
message: oauthErrorMsg || "[Authorization failed]: no accessCode received from the server."
|
||||
});
|
||||
}
|
||||
} else {
|
||||
oauth2.callback({auth: oauth2.auth, token: qp, isValid: isValid, redirectUrl: redirectUrl});
|
||||
}
|
||||
window.close();
|
||||
}
|
||||
|
||||
if (document.readyState !== 'loading') {
|
||||
run();
|
||||
} else {
|
||||
document.addEventListener('DOMContentLoaded', function () {
|
||||
run();
|
||||
});
|
||||
}
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
18
public/swagger/package.json
Normal file
18
public/swagger/package.json
Normal file
@ -0,0 +1,18 @@
|
||||
{
|
||||
"name": "swagger-ui-dist",
|
||||
"version": "5.10.0",
|
||||
"main": "index.js",
|
||||
"repository": "git@github.com:swagger-api/swagger-ui.git",
|
||||
"contributors": [
|
||||
"(in alphabetical order)",
|
||||
"Anna Bodnia <anna.bodnia@gmail.com>",
|
||||
"Buu Nguyen <buunguyen@gmail.com>",
|
||||
"Josh Ponelat <jponelat@gmail.com>",
|
||||
"Kyle Shockey <kyleshockey1@gmail.com>",
|
||||
"Robert Barnwell <robert@robertismy.name>",
|
||||
"Sahar Jafari <shr.jafari@gmail.com>"
|
||||
],
|
||||
"license": "Apache-2.0",
|
||||
"dependencies": {},
|
||||
"devDependencies": {}
|
||||
}
|
||||
20
public/swagger/swagger-initializer.js
Normal file
20
public/swagger/swagger-initializer.js
Normal file
@ -0,0 +1,20 @@
|
||||
window.onload = function() {
|
||||
//<editor-fold desc="Changeable Configuration Block">
|
||||
|
||||
// the following lines will be replaced by docker/configurator, when it runs in a docker-container
|
||||
window.ui = SwaggerUIBundle({
|
||||
url: "https://petstore.swagger.io/v2/swagger.json",
|
||||
dom_id: '#swagger-ui',
|
||||
deepLinking: true,
|
||||
presets: [
|
||||
SwaggerUIBundle.presets.apis,
|
||||
SwaggerUIStandalonePreset
|
||||
],
|
||||
plugins: [
|
||||
SwaggerUIBundle.plugins.DownloadUrl
|
||||
],
|
||||
layout: "StandaloneLayout"
|
||||
});
|
||||
|
||||
//</editor-fold>
|
||||
};
|
||||
3
public/swagger/swagger-ui-bundle.js
Normal file
3
public/swagger/swagger-ui-bundle.js
Normal file
File diff suppressed because one or more lines are too long
1
public/swagger/swagger-ui-bundle.js.map
Normal file
1
public/swagger/swagger-ui-bundle.js.map
Normal file
File diff suppressed because one or more lines are too long
3
public/swagger/swagger-ui-es-bundle-core.js
Normal file
3
public/swagger/swagger-ui-es-bundle-core.js
Normal file
File diff suppressed because one or more lines are too long
1
public/swagger/swagger-ui-es-bundle-core.js.map
Normal file
1
public/swagger/swagger-ui-es-bundle-core.js.map
Normal file
File diff suppressed because one or more lines are too long
3
public/swagger/swagger-ui-es-bundle.js
Normal file
3
public/swagger/swagger-ui-es-bundle.js
Normal file
File diff suppressed because one or more lines are too long
1
public/swagger/swagger-ui-es-bundle.js.map
Normal file
1
public/swagger/swagger-ui-es-bundle.js.map
Normal file
File diff suppressed because one or more lines are too long
3
public/swagger/swagger-ui-standalone-preset.js
Normal file
3
public/swagger/swagger-ui-standalone-preset.js
Normal file
File diff suppressed because one or more lines are too long
1
public/swagger/swagger-ui-standalone-preset.js.map
Normal file
1
public/swagger/swagger-ui-standalone-preset.js.map
Normal file
File diff suppressed because one or more lines are too long
3
public/swagger/swagger-ui.css
Normal file
3
public/swagger/swagger-ui.css
Normal file
File diff suppressed because one or more lines are too long
1
public/swagger/swagger-ui.css.map
Normal file
1
public/swagger/swagger-ui.css.map
Normal file
File diff suppressed because one or more lines are too long
2
public/swagger/swagger-ui.js
Normal file
2
public/swagger/swagger-ui.js
Normal file
File diff suppressed because one or more lines are too long
1
public/swagger/swagger-ui.js.map
Normal file
1
public/swagger/swagger-ui.js.map
Normal file
File diff suppressed because one or more lines are too long
@ -28,6 +28,8 @@ export default {
|
||||
},
|
||||
},
|
||||
cool: {
|
||||
// 实体与路径,跟生成代码、前端请求、swagger文档相关 注意:线上不建议开启,以免保留敏感信息
|
||||
eps: true,
|
||||
// 是否自动导入模块数据库
|
||||
initDB: true,
|
||||
// 是否自动导入模块菜单
|
||||
|
||||
@ -13,6 +13,7 @@ import * as cloud from '@cool-midway/cloud';
|
||||
import * as file from '@cool-midway/file';
|
||||
import * as sms from '@cool-midway/sms';
|
||||
import { ILogger } from '@midwayjs/logger';
|
||||
// import * as swagger from '@midwayjs/swagger';
|
||||
// import * as rpc from '@cool-midway/rpc';
|
||||
// import * as task from '@cool-midway/task';
|
||||
// import * as pay from '@cool-midway/pay';
|
||||
@ -50,6 +51,8 @@ import { ILogger } from '@midwayjs/logger';
|
||||
// iot,
|
||||
// 短信
|
||||
sms,
|
||||
// swagger 文档
|
||||
// swagger,
|
||||
{
|
||||
component: info,
|
||||
enabledEnvironment: ['local'],
|
||||
|
||||
@ -22,7 +22,7 @@ export default () => {
|
||||
// 单点登录
|
||||
sso: false,
|
||||
// 注意: 最好重新修改,防止破解
|
||||
secret: 'cool-admin-xxxxxx',
|
||||
secret: '18d9ed80852a11eebe1a49eaab5535f2',
|
||||
// token
|
||||
token: {
|
||||
// 2小时过期,需要用刷新token
|
||||
|
||||
@ -1,5 +1,12 @@
|
||||
import { Provide, Body, Inject, Post, Get, Query } from '@midwayjs/decorator';
|
||||
import { CoolController, BaseController, CoolEps } from '@cool-midway/core';
|
||||
import {
|
||||
CoolController,
|
||||
BaseController,
|
||||
CoolEps,
|
||||
CoolUrlTag,
|
||||
CoolTag,
|
||||
TagTypes,
|
||||
} from '@cool-midway/core';
|
||||
import { LoginDTO } from '../../dto/login';
|
||||
import { BaseSysLoginService } from '../../service/sys/login';
|
||||
import { BaseSysParamService } from '../../service/sys/param';
|
||||
@ -10,7 +17,8 @@ import { Validate } from '@midwayjs/validate';
|
||||
* 不需要登录的后台接口
|
||||
*/
|
||||
@Provide()
|
||||
@CoolController()
|
||||
@CoolController({ description: '开放接口' })
|
||||
@CoolUrlTag()
|
||||
export class BaseOpenController extends BaseController {
|
||||
@Inject()
|
||||
baseSysLoginService: BaseSysLoginService;
|
||||
@ -28,6 +36,7 @@ export class BaseOpenController extends BaseController {
|
||||
* 实体信息与路径
|
||||
* @returns
|
||||
*/
|
||||
@CoolTag(TagTypes.IGNORE_TOKEN)
|
||||
@Get('/eps', { summary: '实体信息与路径' })
|
||||
public async getEps() {
|
||||
return this.ok(this.eps.admin);
|
||||
@ -36,6 +45,7 @@ export class BaseOpenController extends BaseController {
|
||||
/**
|
||||
* 根据配置参数key获得网页内容(富文本)
|
||||
*/
|
||||
@CoolTag(TagTypes.IGNORE_TOKEN)
|
||||
@Get('/html', { summary: '获得网页内容的参数值' })
|
||||
async htmlByKey(@Query('key') key: string) {
|
||||
this.ctx.body = await this.baseSysParamService.htmlByKey(key);
|
||||
@ -45,6 +55,7 @@ export class BaseOpenController extends BaseController {
|
||||
* 登录
|
||||
* @param login
|
||||
*/
|
||||
@CoolTag(TagTypes.IGNORE_TOKEN)
|
||||
@Post('/login', { summary: '登录' })
|
||||
@Validate()
|
||||
async login(@Body() login: LoginDTO) {
|
||||
@ -54,6 +65,7 @@ export class BaseOpenController extends BaseController {
|
||||
/**
|
||||
* 获得验证码
|
||||
*/
|
||||
@CoolTag(TagTypes.IGNORE_TOKEN)
|
||||
@Get('/captcha', { summary: '验证码' })
|
||||
async captcha(
|
||||
@Query('type') type: string,
|
||||
@ -69,6 +81,7 @@ export class BaseOpenController extends BaseController {
|
||||
/**
|
||||
* 刷新token
|
||||
*/
|
||||
@CoolTag(TagTypes.IGNORE_TOKEN)
|
||||
@Get('/refreshToken', { summary: '刷新token' })
|
||||
async refreshToken(@Query('refreshToken') refreshToken: string) {
|
||||
return this.ok(await this.baseSysLoginService.refreshToken(refreshToken));
|
||||
|
||||
@ -1,9 +1,10 @@
|
||||
import { CoolEvent, Event } from '@cool-midway/core';
|
||||
import { App, Config, ILogger, Logger } from '@midwayjs/core';
|
||||
import { App, Config, ILogger, Inject, Logger } from '@midwayjs/core';
|
||||
import { IMidwayKoaApplication } from '@midwayjs/koa';
|
||||
import * as fs from 'fs';
|
||||
import * as path from 'path';
|
||||
import { v1 as uuid } from 'uuid';
|
||||
import { BaseSwaggerIndex } from '../swagger.ts';
|
||||
|
||||
/**
|
||||
* 修改jwt.secret
|
||||
@ -19,8 +20,12 @@ export class BaseAppEvent {
|
||||
@App()
|
||||
app: IMidwayKoaApplication;
|
||||
|
||||
@Inject()
|
||||
baseSwaggerIndex: BaseSwaggerIndex;
|
||||
|
||||
@Event('onServerReady')
|
||||
async onServerReady() {
|
||||
this.baseSwaggerIndex.init();
|
||||
if (this.config.base.jwt.secret == 'cool-admin-xxxxxx') {
|
||||
const filePath = path.join(
|
||||
this.app.getBaseDir(),
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
import { App, Config, Inject, Middleware } from '@midwayjs/decorator';
|
||||
import * as _ from 'lodash';
|
||||
import { RESCODE } from '@cool-midway/core';
|
||||
import { CoolUrlTagData, RESCODE, TagTypes } from '@cool-midway/core';
|
||||
import * as jwt from 'jsonwebtoken';
|
||||
import { NextFunction, Context } from '@midwayjs/koa';
|
||||
import { IMiddleware, IMidwayApplication } from '@midwayjs/core';
|
||||
import { IMiddleware, IMidwayApplication, Init } from '@midwayjs/core';
|
||||
import { CacheManager } from '@midwayjs/cache';
|
||||
|
||||
/**
|
||||
@ -22,9 +22,19 @@ export class BaseAuthorityMiddleware
|
||||
@Inject()
|
||||
cacheManager: CacheManager;
|
||||
|
||||
@Inject()
|
||||
coolUrlTagData: CoolUrlTagData;
|
||||
|
||||
@App()
|
||||
app: IMidwayApplication;
|
||||
|
||||
ignoreUrls: string[] = [];
|
||||
|
||||
@Init()
|
||||
async init() {
|
||||
this.ignoreUrls = this.coolUrlTagData.byKey(TagTypes.IGNORE_TOKEN, 'admin');
|
||||
}
|
||||
|
||||
resolve() {
|
||||
return async (ctx: Context, next: NextFunction) => {
|
||||
let statusCode = 200;
|
||||
@ -32,8 +42,6 @@ export class BaseAuthorityMiddleware
|
||||
url = url.replace(this.prefix, '');
|
||||
const token = ctx.get('Authorization');
|
||||
const adminUrl = '/admin/';
|
||||
//忽略token验证的url
|
||||
const ignoreUrls = [];
|
||||
// 路由地址为 admin前缀的 需要权限校验
|
||||
if (_.startsWith(url, adminUrl)) {
|
||||
try {
|
||||
@ -48,10 +56,7 @@ export class BaseAuthorityMiddleware
|
||||
}
|
||||
} catch (error) {}
|
||||
// 不需要登录 无需权限校验
|
||||
if (
|
||||
new RegExp(`^${adminUrl}?.*/open/`).test(url) ||
|
||||
ignoreUrls.includes(url)
|
||||
) {
|
||||
if (this.ignoreUrls.includes(url)) {
|
||||
await next();
|
||||
return;
|
||||
}
|
||||
|
||||
84
src/modules/base/swagger.ts/index.ts
Normal file
84
src/modules/base/swagger.ts/index.ts
Normal file
@ -0,0 +1,84 @@
|
||||
import {
|
||||
App,
|
||||
ILogger,
|
||||
IMidwayApplication,
|
||||
Logger,
|
||||
Provide,
|
||||
Scope,
|
||||
ScopeEnum,
|
||||
} from '@midwayjs/core';
|
||||
import * as path from 'path';
|
||||
import * as fs from 'fs';
|
||||
|
||||
/**
|
||||
* swagger
|
||||
*/
|
||||
@Provide()
|
||||
@Scope(ScopeEnum.Singleton)
|
||||
export class BaseSwaggerIndex {
|
||||
@Logger()
|
||||
coreLogger: ILogger;
|
||||
|
||||
@App()
|
||||
app: IMidwayApplication;
|
||||
|
||||
basePath = '';
|
||||
lockPath = '';
|
||||
|
||||
/**
|
||||
* 初始化
|
||||
*/
|
||||
async init() {
|
||||
this.basePath = this.app.getBaseDir();
|
||||
this.lockPath = path.join(this.basePath, '..', 'lock');
|
||||
//this.copyToPublic();
|
||||
}
|
||||
|
||||
/**
|
||||
* 将swagger静态资源包复制到public目录下
|
||||
*/
|
||||
async copyToPublic() {
|
||||
const lockFile = path.join(this.lockPath, 'static.swagger.lock');
|
||||
if (fs.existsSync(lockFile)) return;
|
||||
// swagger静态资源包
|
||||
const swaggerUiAssetPath = require('swagger-ui-dist').getAbsoluteFSPath();
|
||||
console.log('swaggerUiAssetPath', swaggerUiAssetPath);
|
||||
// 复制整个目录到public的swagger目录下 没有则创建
|
||||
const publicPath = path.join(this.basePath, '..', 'public');
|
||||
const swaggerPath = path.join(publicPath, 'swagger');
|
||||
if (!fs.existsSync(swaggerPath)) {
|
||||
fs.mkdirSync(swaggerPath);
|
||||
}
|
||||
this.copyDirectory(swaggerUiAssetPath, swaggerPath);
|
||||
fs.writeFileSync(lockFile, 'static');
|
||||
this.coreLogger.info(
|
||||
'\x1B[36m [cool:module:base] midwayjs cool module base swagger static copy to public\x1B[0m'
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* 复制目录
|
||||
* @param src
|
||||
* @param dest
|
||||
*/
|
||||
copyDirectory(src, dest) {
|
||||
// 确保目标文件夹存在
|
||||
fs.mkdirSync(dest, { recursive: true });
|
||||
|
||||
// 读取源文件夹中的所有文件和子文件夹
|
||||
let entries = fs.readdirSync(src, { withFileTypes: true });
|
||||
|
||||
for (let entry of entries) {
|
||||
let srcPath = path.join(src, entry.name);
|
||||
let destPath = path.join(dest, entry.name);
|
||||
|
||||
// 递归复制子文件夹
|
||||
if (entry.isDirectory()) {
|
||||
this.copyDirectory(srcPath, destPath);
|
||||
} else {
|
||||
// 同步复制文件
|
||||
fs.copyFileSync(srcPath, destPath);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -41,7 +41,7 @@ export default () => {
|
||||
// 刷新token 过期时间,单位秒
|
||||
refreshExpire: 60 * 60 * 24 * 30,
|
||||
// jwt 秘钥
|
||||
secret: 'cool-app-xxxxxx',
|
||||
secret: '18da1490852a11eebe1a49eaab5535f2',
|
||||
},
|
||||
} as ModuleConfig;
|
||||
};
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
import { ALL, Config, Middleware } from '@midwayjs/decorator';
|
||||
import { NextFunction, Context } from '@midwayjs/koa';
|
||||
import { IMiddleware, Inject } from '@midwayjs/core';
|
||||
import { IMiddleware, Init, Inject } from '@midwayjs/core';
|
||||
import * as jwt from 'jsonwebtoken';
|
||||
import * as _ from 'lodash';
|
||||
import { CoolUrlTagData, RESCODE, TagTypes } from '@cool-midway/core';
|
||||
@ -19,13 +19,15 @@ export class UserMiddleware implements IMiddleware<Context, NextFunction> {
|
||||
@Config('module.user.jwt')
|
||||
jwtConfig;
|
||||
|
||||
protected ignoreUrls = [];
|
||||
ignoreUrls: string[] = [];
|
||||
|
||||
@Init()
|
||||
async init() {
|
||||
this.ignoreUrls = this.coolUrlTagData.byKey(TagTypes.IGNORE_TOKEN, 'app');
|
||||
}
|
||||
|
||||
resolve() {
|
||||
return async (ctx: Context, next: NextFunction) => {
|
||||
const ignoreUrls = this.ignoreUrls.concat(
|
||||
this.coolUrlTagData.byKey(TagTypes.IGNORE_TOKEN)
|
||||
);
|
||||
let { url } = ctx;
|
||||
url = url.split('?')[0];
|
||||
if (_.startsWith(url, '/app/')) {
|
||||
@ -41,7 +43,7 @@ export class UserMiddleware implements IMiddleware<Context, NextFunction> {
|
||||
return;
|
||||
}
|
||||
} catch (error) {}
|
||||
if (ignoreUrls.includes(url)) {
|
||||
if (this.ignoreUrls.includes(url)) {
|
||||
await next();
|
||||
return;
|
||||
} else {
|
||||
|
||||
16
src/swagger.ts
Normal file
16
src/swagger.ts
Normal file
@ -0,0 +1,16 @@
|
||||
import { Controller, Get, Inject } from '@midwayjs/decorator';
|
||||
import { Context } from '@midwayjs/koa';
|
||||
|
||||
/**
|
||||
* 欢迎界面
|
||||
*/
|
||||
@Controller('/')
|
||||
export class WelcomeController {
|
||||
@Inject()
|
||||
ctx: Context;
|
||||
|
||||
@Get('/swagger', { summary: 'swagger界面' })
|
||||
public async swagger() {
|
||||
await this.ctx.render('swagger', {});
|
||||
}
|
||||
}
|
||||
@ -1,5 +1,5 @@
|
||||
import { App, Controller, Get, Inject } from '@midwayjs/decorator';
|
||||
import { Context, Application } from '@midwayjs/koa';
|
||||
import { Controller, Get, Inject } from '@midwayjs/decorator';
|
||||
import { Context } from '@midwayjs/koa';
|
||||
|
||||
/**
|
||||
* 欢迎界面
|
||||
@ -9,10 +9,7 @@ export class WelcomeController {
|
||||
@Inject()
|
||||
ctx: Context;
|
||||
|
||||
@App()
|
||||
app: Application;
|
||||
|
||||
@Get('/')
|
||||
@Get('/', { summary: '欢迎界面' })
|
||||
public async welcome() {
|
||||
await this.ctx.render('welcome', {
|
||||
text: 'HELLO COOL-ADMIN v7.0 一个项目用COOL就够了!!!',
|
||||
|
||||
19
view/swagger.html
Normal file
19
view/swagger.html
Normal file
@ -0,0 +1,19 @@
|
||||
<!-- HTML for static distribution bundle build -->
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<title>Cool Admin Swagger UI</title>
|
||||
<link rel="stylesheet" type="text/css" href="/public/swagger/swagger-ui.css" />
|
||||
<link rel="stylesheet" type="text/css" href="/public/swagger/index.css" />
|
||||
<link rel="icon" type="image/png" href="/public/swagger/favicon-32x32.png" sizes="32x32" />
|
||||
<link rel="icon" type="image/png" href="/public/swagger/favicon-16x16.png" sizes="16x16" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<div id="swagger-ui"></div>
|
||||
<script src="/public/swagger/swagger-ui-bundle.js" charset="UTF-8"> </script>
|
||||
<script src="/public/swagger/swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
|
||||
<script src="/public/swagger/swagger-initializer.js" charset="UTF-8"> </script>
|
||||
</body>
|
||||
</html>
|
||||
Loading…
x
Reference in New Issue
Block a user