0.0.1-beta.53 • Published 5 months ago
@bkui/apigateway-nodejs-sdk v0.0.1-beta.53
蓝鲸 APIGATEWAY-NODE-SDK
安装使用
npm i '@bkui/apigateway-nodejs-sdk'
import {
syncApi
} from '@bkui/apigateway-nodejs-sdk'
syncApi(
'网关名称',
{
description: '',
maintainers: [],
status: 1,
is_public: true,
user_auth_type: 'default'
},
{
bk_app_code: 'xxx',
bk_app_secret: 'xxx'
},
'prod'
)
SDK 功能
详细接口参数请查阅 APIGATEWAY 文档,下面列出 SDK 导出的功能
同步网关
const syncApi: (api_name: string, httpBody: any, authorization: IAuthorization, stageName: string) => Promise<any>
同步环境
const syncStage: (api_name: string, httpBody: any, authorization: IAuthorization, stageName: string) => Promise<any>
同步资源
const syncResources: (api_name: string, httpBody: any, authorization: IAuthorization, stageName: string) => Promise<any>
同步策略
const syncAccessStrategy: (api_name: string, httpBody: any, authorization: IAuthorization, stageName: string) => Promise<any>
回收应用访问网关 API 的权限
const revokePermissions: (api_name: string, httpBody: any, authorization: IAuthorization, stageName: string) => Promise<any>
发布版本
const release: (api_name: string, httpBody: any, authorization: IAuthorization, stageName: string) => Promise<any>
网关为应用主动授权
const grantPermissions: (api_name: string, httpBody: any, authorization: IAuthorization, stageName: string) => Promise<any>
获取网关最新版本
const getLatestResourceVersion: (api_name: string, authorization: IAuthorization, stageName: string) => Promise<any>
获取网关公钥
const getPublicKey: (api_name: string, authorization: IAuthorization, stageName: string) => Promise<any>
创建资源版本
const createResourceVersion: (api_name: string, httpBody: any, authorization: IAuthorization, stageName: string) => Promise<any>
申请网关API访问权限
const applyPermissions: (api_name: string, httpBody: any, authorization: IAuthorization, stageName: string) => Promise<any>
添加网关关联应用
const addRelatedApps: (api_name: string, httpBody: any, authorization: IAuthorization, stageName: string) => Promise<any>
解码 apigateway token
const decodeToken: (api_name: string, jwtToken: string, authorization: IAuthorization, stageName: string) => Promise<any>
执行 apigateway 接口
const execApiGateWay: ({ api_name: string, apiUrlTemp: string, path: string, method: string, data: any, authorization: IAuthorization, stageName: string }) => Promise<any>
参数解读
// apigateway 认证参数,必填
interface IAuthorization {
bk_app_code: '',
bk_app_secret: '',
access_token: ''
}
api_name: '网关名称'
httpBody: '请求参数,详细请查阅 apigateway 文档'
stageName: '环境名称,prod/stag 等等'
apiUrlTemp: '网关地址模板,可不传,会通过部署环境自动匹配'
path: '网关接口path'
method: '网关接口方法'
0.0.1-beta.53
5 months ago
0.0.1-beta.43
9 months ago
0.0.1-beta.42
9 months ago
0.0.1-beta.45
9 months ago
0.0.1-beta.41
10 months ago
0.0.1-beta.40
10 months ago
0.0.1-beta.47
9 months ago
0.0.1-beta.46
9 months ago
0.0.1-beta.49
8 months ago
0.0.1-beta.48
9 months ago
0.0.1-beta.32
10 months ago
0.0.1-beta.34
10 months ago
0.0.1-beta.33
10 months ago
0.0.1-beta.39
10 months ago
0.0.1-beta.36
10 months ago
0.0.1-beta.35
10 months ago
0.0.1-beta.38
10 months ago
0.0.1-beta.37
10 months ago
0.0.1-beta.50
8 months ago
0.0.1-beta.52
8 months ago
0.0.1-beta.51
8 months ago
0.0.1-beta.29
2 years ago
0.0.1-beta.31
2 years ago
0.0.1-beta.30
2 years ago
0.0.1-beta.28
2 years ago
0.0.1-beta.27
2 years ago
0.0.1-beta.26
2 years ago
0.0.1-beta.25
2 years ago
0.0.1-beta.24
2 years ago
0.0.1-beta.23
2 years ago
0.0.1-beta.21
2 years ago
0.0.1-beta.18
2 years ago
0.0.1-beta.17
2 years ago
0.0.1-beta.16
2 years ago
0.0.1-beta.15
2 years ago
0.0.1-beta.14
2 years ago
0.0.1-beta.13
2 years ago
0.0.1-beta.12
2 years ago
0.0.1-beta.11
2 years ago
0.0.1-beta.10
2 years ago
0.0.1-beta.9
2 years ago
0.0.1-beta.8
2 years ago
0.0.1-beta.7
2 years ago
0.0.1-beta.6
2 years ago
0.0.1-beta.5
2 years ago
0.0.1-beta.4
2 years ago
0.0.1-beta.3
2 years ago
0.0.1-beta.2
2 years ago
0.0.1-beta.1
2 years ago