蓝鲸 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: '网关接口方法'