feat: API 网关文档版本号通过变量渲染 (#1620)

TencentBlueKing · Sep 24, 2024 · 9c59460 · 9c59460
1 parent a8537ed
commit 9c59460
Show file tree

Hide file tree

Showing 7 changed files with 11 additions and 14 deletions.
diff --git a/webfe/package_vue/.bk.production.env b/webfe/package_vue/.bk.production.env
@@ -27,3 +27,5 @@ BK_MAX_PACKAGE_SIZE = '\$BK_MAX_PACKAGE_SIZE'
 BK_SHARED_RES_URL = '\$BK_SHARED_RES_URL'
 
 BK_PAAS_DOCS_VER = '\$BK_PAAS_DOCS_VER'
+
+BK_APIGW_DOCS_VER = '\$BK_APIGW_DOCS_VER'
diff --git a/webfe/package_vue/index.html b/webfe/package_vue/index.html
@@ -18,13 +18,15 @@
       var BK_PAAS2_URL = '<%= process.env.BK_PAAS2_URL %>' || ''
       var BK_DOCS_URL_PREFIX = '<%= process.env.BK_DOCS_URL_PREFIX %>' || ''
       var BK_PAAS_DOCS_VER = '<%= process.env.BK_PAAS_DOCS_VER %>' || ''
+      var BK_APIGW_DOCS_VER = '<%= process.env.BK_APIGW_DOCS_VER %>' || ''
       var BK_APIGW_URL = '<%= process.env.BK_APIGW_URL %>' || ''
       var BK_APIGW_DOC_URL = '<%= process.env.BK_APIGW_DOC_URL %>' || ''
       var BK_COMPONENT_API_URL = '<%= process.env.BK_COMPONENT_API_URL %>' || ''
       var BK_ANALYSIS_JS = '<%= process.env.BK_ANALYSIS_JS %>' || ''
 
       var PAAS_DOCS_URL_PREFIX = `<%= process.env.BK_DOCS_URL_PREFIX %>/markdown/ZH/PaaS/<%= process.env.BK_PAAS_DOCS_VER %>`
       var DOCS_URL_PREFIX = `<%= process.env.BK_DOCS_URL_PREFIX %>/markdown/ZH/PaaS/<%= process.env.BK_PAAS_DOCS_VER %>/BaseGuide`
+      var APIGW_DOCS_PREFIX = `<%= process.env.BK_DOCS_URL_PREFIX %>/markdown/ZH/APIGateway/<%= process.env.BK_APIGW_DOCS_VER %>`
       var BK_STATIC_URL = '<%= process.env.BK_STATIC_URL %>' || ''
       var BK_PAAS_VERSION = '<%= process.env.BK_PAAS_VERSION %>' || ''
       var BK_SHARED_RES_URL = '<%= process.env.BK_SHARED_RES_URL %>' || ''

diff --git a/webfe/package_vue/src/views/dev-center/app/basic-config/cloud-api/index.vue b/webfe/package_vue/src/views/dev-center/app/basic-config/cloud-api/index.vue
@@ -201,7 +201,6 @@ export default {
       linkMap: {
         gateway: this.GLOBAL.DOC.APIGW_QUICK_START,
         API: this.GLOBAL.DOC.APIGW_USER_API,
-        FAQ: this.GLOBAL.DOC.APIGW_FAQ,
       },
       panels: [
         { name: 'gatewayApi', label: this.$t('网关API') },

diff --git a/webfe/package_vue/static/json/paas_static.ce.js b/webfe/package_vue/static/json/paas_static.ce.js
@@ -237,9 +237,6 @@ export const PLATFORM_CONFIG = {
         // APIGW QUICK_START
         APIGW_QUICK_START: BK_APIGW_DOC_URL + '/guide/quickstart.html',
 
-        // APIGW API调用指引
-        APIGW_FAQ: BK_APIGW_DOC_URL + '/guide/faq.html',
-
         LESSCODE_START: BK_LESSCODE_URL + '/help/start',
 
         // Python 开发规范

diff --git a/webfe/package_vue/static/json/paas_static.ee.js b/webfe/package_vue/static/json/paas_static.ee.js
@@ -232,16 +232,10 @@ export const PLATFORM_CONFIG = {
         BKUI_WITH_PYTHON: DOCS_URL_PREFIX + '/topics/bkui/with-python',
 
         // APIGW API调用指引
-        // APIGW_USER_API: BK_APIGW_DOC_URL + '/guide/use-api.html',
-        APIGW_USER_API: BK_DOCS_URL_PREFIX + '/markdown/APIGateway/apigateway/use-api/use-apigw-api.md',
+        APIGW_USER_API: APIGW_DOCS_PREFIX + '/UserGuide/HowTo/call-gateway-api.md',
 
-        // APIGW QUICK_START
-        // APIGW_QUICK_START: BK_APIGW_DOC_URL + '/guide/quickstart.html',
-        APIGW_QUICK_START: BK_DOCS_URL_PREFIX + '/markdown/APIGateway/apigateway/quickstart/create-api-with-http-backend.md',
-
-        // APIGW FAQ
-        // APIGW_FAQ: BK_APIGW_DOC_URL + '/guide/faq.html',
-        APIGW_FAQ: BK_DOCS_URL_PREFIX + '/markdown/APIGateway/apigateway/faq/use-apigw-api.md',
+        // APIGW API 网关接入指引
+        APIGW_QUICK_START: APIGW_DOCS_PREFIX + '/UserGuide/HowTo/Connect/connect-gateway.md',
 
         LESSCODE_START: BK_LESSCODE_URL + '/help/start',
 

diff --git a/webfe/package_vue/static/runtime/runtime.ce.js b/webfe/package_vue/static/runtime/runtime.ce.js
@@ -30,9 +30,10 @@ var BK_PAAS_VERSION = process.env.BK_PAAS_VERSION || ''
 var BK_MAX_PACKAGE_SIZE = process.env.BK_MAX_PACKAGE_SIZE || ''
 var BK_SHARED_RES_URL = process.env.BK_SHARED_RES_URL || ''
 var BK_PAAS_DOCS_VER = process.env.BK_PAAS_DOCS_VER || ''
+var BK_APIGW_DOCS_VER = process.env.BK_APIGW_DOCS_VER || ''
 
 var BACKEND_URL = `${SITE_URL}/backend` // 后端接口前缀
 var PAAS_DOCS_URL_PREFIX = `${BK_DOCS_URL_PREFIX}/markdown/ZH/PaaS/${BK_PAAS_DOCS_VER}` // PaaS 产品文档前缀
 var DOCS_URL_PREFIX = `${PAAS_DOCS_URL_PREFIX}/BaseGuide` // 开发者资料库前缀
-
+var PAAS_DOCS_URL_PREFIX = `${BK_DOCS_URL_PREFIX}/markdown/ZH/APIGateway/${BK_APIGW_DOCS_VER}` // API 网关文档前缀
 var USERS_URL = `${BK_COMPONENT_API_URL}/api/c/compapi/v2/usermanage/fs_list_users/` // 人员选择器接口地址，可选填
diff --git a/webfe/package_vue/static/runtime/runtime.ee.js b/webfe/package_vue/static/runtime/runtime.ee.js
@@ -30,8 +30,10 @@ var BK_PAAS_VERSION = process.env.BK_PAAS_VERSION || ''
 var BK_MAX_PACKAGE_SIZE = process.env.BK_MAX_PACKAGE_SIZE || ''
 var BK_SHARED_RES_URL = process.env.BK_SHARED_RES_URL || ''
 var BK_PAAS_DOCS_VER = process.env.BK_PAAS_DOCS_VER || ''
+var BK_APIGW_DOCS_VER = process.env.BK_APIGW_DOCS_VER || ''
 
 var BACKEND_URL = `${SITE_URL}/backend` // 后端接口前缀
 var PAAS_DOCS_URL_PREFIX = `${BK_DOCS_URL_PREFIX}/markdown/ZH/PaaS/${BK_PAAS_DOCS_VER}` // PaaS 产品文档前缀
 var DOCS_URL_PREFIX = `${PAAS_DOCS_URL_PREFIX}/BaseGuide` // 开发者资料库前缀
+var PAAS_DOCS_URL_PREFIX = `${BK_DOCS_URL_PREFIX}/markdown/ZH/APIGateway/${BK_APIGW_DOCS_VER}` // API 网关文档前缀
 var USERS_URL = `${BK_COMPONENT_API_URL}/api/c/compapi/v2/usermanage/fs_list_users/` // 人员选择器接口地址，可选填
Original file line number	Diff line number	Diff line change
Expand Up		@@ -27,3 +27,5 @@ BK_MAX_PACKAGE_SIZE = '\$BK_MAX_PACKAGE_SIZE'
		BK_SHARED_RES_URL = '\$BK_SHARED_RES_URL'

		BK_PAAS_DOCS_VER = '\$BK_PAAS_DOCS_VER'

		BK_APIGW_DOCS_VER = '\$BK_APIGW_DOCS_VER'