From 5cb267fba6526e062c05f155b9bdf0447d8e43c6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9A=AE=E5=85=89=EF=BC=9A=E5=9F=8E=E4=B8=AD=E5=9F=8E?= <806783409@qq.com> Date: Wed, 20 Oct 2021 22:32:25 +0800 Subject: [PATCH] =?UTF-8?q?swagger=E6=96=87=E6=A1=A3=E5=B1=95=E7=A4=BA?= =?UTF-8?q?=E5=BC=80=E5=8F=91?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../framework/config/ZyplayerDocConfig.java | 8 +-- .../controller/SwaggerProxyController.java | 2 +- .../config/EnableDocSwaggerPlus.java | 2 +- zyplayer-doc-ui/swagger-ui/.env.development | 4 +- zyplayer-doc-ui/swagger-ui/.env.production | 3 +- zyplayer-doc-ui/swagger-ui/package-lock.json | 34 +++++++---- zyplayer-doc-ui/swagger-ui/package.json | 2 +- zyplayer-doc-ui/swagger-ui/src/api/custom.js | 6 ++ zyplayer-doc-ui/swagger-ui/src/api/index.js | 1 + .../swagger-ui/src/api/request/custom.js | 14 +++++ .../src/api/request/interceptors.js | 4 +- .../swagger-ui/src/api/request/utils.js | 12 ++++ .../src/components/layouts/MenuLayout.vue | 60 ++++++------------- zyplayer-doc-ui/swagger-ui/src/routes.js | 10 +++- .../swagger-ui/src/views/doc/DocManage.vue | 48 +++++++++++++++ zyplayer-doc-ui/swagger-ui/vite.config.js | 1 + 16 files changed, 146 insertions(+), 65 deletions(-) create mode 100644 zyplayer-doc-ui/swagger-ui/src/api/custom.js create mode 100644 zyplayer-doc-ui/swagger-ui/src/api/request/custom.js create mode 100644 zyplayer-doc-ui/swagger-ui/src/views/doc/DocManage.vue diff --git a/zyplayer-doc-manage/src/main/java/com/zyplayer/doc/manage/framework/config/ZyplayerDocConfig.java b/zyplayer-doc-manage/src/main/java/com/zyplayer/doc/manage/framework/config/ZyplayerDocConfig.java index 7ab9f82d..53ba0125 100644 --- a/zyplayer-doc-manage/src/main/java/com/zyplayer/doc/manage/framework/config/ZyplayerDocConfig.java +++ b/zyplayer-doc-manage/src/main/java/com/zyplayer/doc/manage/framework/config/ZyplayerDocConfig.java @@ -32,9 +32,9 @@ public class ZyplayerDocConfig { @EnableDocDb public class enableDocDb{} - @EnableDocSwagger(selfDoc = false) - public class enableDocSwagger{} +// @EnableDocSwagger(selfDoc = false) +// public class enableDocSwagger{} -// @EnableDocSwaggerPlus -// public class enableDocSwaggerPlus{} + @EnableDocSwaggerPlus + public class enableDocSwaggerPlus{} } diff --git a/zyplayer-doc-swagger-plus/src/main/java/com/zyplayer/doc/swaggerplus/controller/SwaggerProxyController.java b/zyplayer-doc-swagger-plus/src/main/java/com/zyplayer/doc/swaggerplus/controller/SwaggerProxyController.java index 6a5d7a2a..ae1e77da 100644 --- a/zyplayer-doc-swagger-plus/src/main/java/com/zyplayer/doc/swaggerplus/controller/SwaggerProxyController.java +++ b/zyplayer-doc-swagger-plus/src/main/java/com/zyplayer/doc/swaggerplus/controller/SwaggerProxyController.java @@ -38,7 +38,7 @@ public class SwaggerProxyController { List docList = swaggerDocService.getSwaggerDocList(); for (SwaggerDoc swaggerDoc : docList) { SwaggerResource resource = new SwaggerResource(); - resource.setLocation(swaggerDoc.getDocUrl()); + resource.setUrl("/doc-swagger/doc/content?id=" + swaggerDoc.getId()); resource.setName(swaggerDoc.getName()); resource.setSwaggerVersion("2.0"); resourceList.add(resource); diff --git a/zyplayer-doc-swagger-plus/src/main/java/com/zyplayer/doc/swaggerplus/framework/config/EnableDocSwaggerPlus.java b/zyplayer-doc-swagger-plus/src/main/java/com/zyplayer/doc/swaggerplus/framework/config/EnableDocSwaggerPlus.java index 8fa30fea..0456b13d 100644 --- a/zyplayer-doc-swagger-plus/src/main/java/com/zyplayer/doc/swaggerplus/framework/config/EnableDocSwaggerPlus.java +++ b/zyplayer-doc-swagger-plus/src/main/java/com/zyplayer/doc/swaggerplus/framework/config/EnableDocSwaggerPlus.java @@ -10,7 +10,7 @@ import java.lang.annotation.*; @Documented @Configuration @ComponentScan(basePackages = { - "com.zyplayer.doc.swagger", + "com.zyplayer.doc.swaggerplus", }) public @interface EnableDocSwaggerPlus { diff --git a/zyplayer-doc-ui/swagger-ui/.env.development b/zyplayer-doc-ui/swagger-ui/.env.development index a9d73dd3..99cd1a9c 100644 --- a/zyplayer-doc-ui/swagger-ui/.env.development +++ b/zyplayer-doc-ui/swagger-ui/.env.development @@ -1,11 +1,13 @@ VITE_APP_TITLE=swagger文档管理 本地切换环境改这个参数，可选值：dev、online -VITE_APP_ENV=online +VITE_APP_ENV=dev # 线上环境 VITE_APP_BASE_URL_ONLINE=http://doc.zyplayer.com/zyplayer-doc-manage +VITE_APP_CUSTOM_URL_ONLINE=http://doc.zyplayer.com/zyplayer-doc-manage # 本地环境 VITE_APP_BASE_URL_DEV=http://local.zyplayer.com:8083/zyplayer-doc-manage +VITE_APP_CUSTOM_URL_DEV=http://local.zyplayer.com:8083/zyplayer-doc-manage diff --git a/zyplayer-doc-ui/swagger-ui/.env.production b/zyplayer-doc-ui/swagger-ui/.env.production index f4b165d0..90f1c788 100644 --- a/zyplayer-doc-ui/swagger-ui/.env.production +++ b/zyplayer-doc-ui/swagger-ui/.env.production @@ -3,4 +3,5 @@ VITE_APP_TITLE=swagger文档管理 VITE_APP_ENV=online # 线上环境 -VITE_APP_BASE_URL_ONLINE=http://doc.zyplayer.com/zyplayer-doc-manage +VITE_APP_BASE_URL_ONLINE=./ +VITE_APP_CUSTOM_URL_ONLINE=./ diff --git a/zyplayer-doc-ui/swagger-ui/package-lock.json b/zyplayer-doc-ui/swagger-ui/package-lock.json index f97119a7..041b66ce 100644 --- a/zyplayer-doc-ui/swagger-ui/package-lock.json +++ b/zyplayer-doc-ui/swagger-ui/package-lock.json @@ -223,26 +223,41 @@ } }, "ant-design-vue": { - "version": "2.2.8", - "resolved": "https://registry.npmmirror.com/ant-design-vue/download/ant-design-vue-2.2.8.tgz", - "integrity": "sha1-+ofPaELY7poNivOT/0CZ7MQHLys=", + "version": "3.0.0-alpha.4", + "resolved": "https://registry.npmmirror.com/ant-design-vue/download/ant-design-vue-3.0.0-alpha.4.tgz?cache=0&sync_timestamp=1634696108824&other_urls=https%3A%2F%2Fregistry.npmmirror.com%2Fant-design-vue%2Fdownload%2Fant-design-vue-3.0.0-alpha.4.tgz", + "integrity": "sha1-A+3f7Tv17UCbKBQyC1pxQ+Z2r/U=", "requires": { + "@ant-design/colors": "^6.0.0", "@ant-design/icons-vue": "^6.0.0", "@babel/runtime": "^7.10.5", "@simonwep/pickr": "~1.8.0", "array-tree-filter": "^2.1.0", - "async-validator": "^3.3.0", + "async-validator": "^4.0.0", + "dayjs": "^1.10.5", "dom-align": "^1.12.1", "dom-scroll-into-view": "^2.0.0", "lodash": "^4.17.21", "lodash-es": "^4.17.15", - "moment": "^2.27.0", - "omit.js": "^2.0.0", "resize-observer-polyfill": "^1.5.1", "scroll-into-view-if-needed": "^2.2.25", "shallow-equal": "^1.0.0", "vue-types": "^3.0.0", "warning": "^4.0.0" + }, + "dependencies": { + "@ant-design/colors": { + "version": "6.0.0", + "resolved": "https://registry.npm.taobao.org/@ant-design/colors/download/@ant-design/colors-6.0.0.tgz", + "integrity": "sha1-m5NmJXz/zEfbQrnQIDu1ksE8Apg=", + "requires": { + "@ctrl/tinycolor": "^3.4.0" + } + }, + "async-validator": { + "version": "4.0.7", + "resolved": "https://registry.npmmirror.com/async-validator/download/async-validator-4.0.7.tgz", + "integrity": "sha1-A0oP0hA6ay6/AQ2nUYO+wpkkev4=" + } } }, "anymatch": { @@ -1198,11 +1213,6 @@ "resolved": "https://registry.nlark.com/object-inspect/download/object-inspect-1.10.3.tgz", "integrity": "sha1-wqp9LQn1DJk3VwT3oK3yTFeC02k=" }, - "omit.js": { - "version": "2.0.2", - "resolved": "https://registry.npm.taobao.org/omit.js/download/omit.js-2.0.2.tgz", - "integrity": "sha1-3ZuENvq5R6Xz/yFMslOGMeMT7C8=" - }, "param-case": { "version": "3.0.4", "resolved": "https://registry.nlark.com/param-case/download/param-case-3.0.4.tgz", @@ -1769,7 +1779,7 @@ }, "vue-types": { "version": "3.0.2", - "resolved": "https://registry.nlark.com/vue-types/download/vue-types-3.0.2.tgz", + "resolved": "https://registry.npmmirror.com/vue-types/download/vue-types-3.0.2.tgz", "integrity": "sha1-7BbgXUEsA4Ji/B76TOuWR+f7YB0=", "requires": { "is-plain-object": "3.0.1" diff --git a/zyplayer-doc-ui/swagger-ui/package.json b/zyplayer-doc-ui/swagger-ui/package.json index 4717f154..f747f63b 100644 --- a/zyplayer-doc-ui/swagger-ui/package.json +++ b/zyplayer-doc-ui/swagger-ui/package.json @@ -8,7 +8,7 @@ }, "dependencies": { "@ant-design/icons-vue": "^6.0.1", - "ant-design-vue": "^2.2.8", + "ant-design-vue": "^3.0.0-alpha.4", "axios": "^0.19.2", "brace": "^0.11.1", "element-plus": "^1.0.2-beta.71", diff --git a/zyplayer-doc-ui/swagger-ui/src/api/custom.js b/zyplayer-doc-ui/swagger-ui/src/api/custom.js new file mode 100644 index 00000000..b8915b4d --- /dev/null +++ b/zyplayer-doc-ui/swagger-ui/src/api/custom.js @@ -0,0 +1,6 @@ +import apiClient from './request/custom.js' + +export const customApi = { + post: (url, data) => apiClient({url: url, method: 'post', data: data}), +}; + diff --git a/zyplayer-doc-ui/swagger-ui/src/api/index.js b/zyplayer-doc-ui/swagger-ui/src/api/index.js index 2fa1706a..fed89c30 100644 --- a/zyplayer-doc-ui/swagger-ui/src/api/index.js +++ b/zyplayer-doc-ui/swagger-ui/src/api/index.js @@ -1,3 +1,4 @@ export { zyplayerApi } from './zyplayer.js'; +export { customApi } from './custom.js'; diff --git a/zyplayer-doc-ui/swagger-ui/src/api/request/custom.js b/zyplayer-doc-ui/swagger-ui/src/api/request/custom.js new file mode 100644 index 00000000..0110608e --- /dev/null +++ b/zyplayer-doc-ui/swagger-ui/src/api/request/custom.js @@ -0,0 +1,14 @@ +import Axios from 'axios' +import interceptors from './interceptors' +import {getCustomApiBaseUrl} from "./utils"; + +const apiClient = Axios.create({ + baseURL: getCustomApiBaseUrl(), + timeout: 20000, + headers: {'Content-type': 'application/x-www-form-urlencoded'}, + withCredentials: true +}); +interceptors(apiClient); + +export default apiClient; + diff --git a/zyplayer-doc-ui/swagger-ui/src/api/request/interceptors.js b/zyplayer-doc-ui/swagger-ui/src/api/request/interceptors.js index 794ff7de..a6055359 100644 --- a/zyplayer-doc-ui/swagger-ui/src/api/request/interceptors.js +++ b/zyplayer-doc-ui/swagger-ui/src/api/request/interceptors.js @@ -4,7 +4,7 @@ import {getZyplayerApiBaseUrl} from "./utils"; // 增加不需要验证结果的标记 const noValidate = { - "/zyplayer-doc-db/executor/execute": true, + "./swagger-resources": true, "/zyplayer-doc-db/datasource/test": true, }; @@ -38,7 +38,7 @@ export default function (axios) { response => { if (!!response.message) { vue.$message.error('请求错误：' + response.message); - }else { + } else { if (!response.config.needValidateResult || response.data.errCode === 200) { return response.data; } else if (response.data.errCode === 400) { diff --git a/zyplayer-doc-ui/swagger-ui/src/api/request/utils.js b/zyplayer-doc-ui/swagger-ui/src/api/request/utils.js index a1f60f5a..98ba6eb9 100644 --- a/zyplayer-doc-ui/swagger-ui/src/api/request/utils.js +++ b/zyplayer-doc-ui/swagger-ui/src/api/request/utils.js @@ -11,3 +11,15 @@ export function getZyplayerApiBaseUrl() { return baseUrl; } +/** + * 获取custom后端域名 + */ +export function getCustomApiBaseUrl() { + let env = import.meta.env.VITE_APP_ENV; + let baseUrl = import.meta.env.VITE_APP_CUSTOM_URL_ONLINE; + if ("dev" === env) { + baseUrl = import.meta.env.VITE_APP_CUSTOM_URL_DEV; + } + return baseUrl; +} + diff --git a/zyplayer-doc-ui/swagger-ui/src/components/layouts/MenuLayout.vue b/zyplayer-doc-ui/swagger-ui/src/components/layouts/MenuLayout.vue index 870a5377..c796754a 100644 --- a/zyplayer-doc-ui/swagger-ui/src/components/layouts/MenuLayout.vue +++ b/zyplayer-doc-ui/swagger-ui/src/components/layouts/MenuLayout.vue @@ -1,31 +1,20 @@ diff --git a/zyplayer-doc-ui/swagger-ui/vite.config.js b/zyplayer-doc-ui/swagger-ui/vite.config.js index 6c3bfb8d..f3db6993 100644 --- a/zyplayer-doc-ui/swagger-ui/vite.config.js +++ b/zyplayer-doc-ui/swagger-ui/vite.config.js @@ -8,6 +8,7 @@ export default defineConfig({ server: { host: 'local.zyplayer.com', port: 80, + // https: true }, base: '', plugins: [