tgit-api v0.67.1

tgit-api

腾讯工蜂 RESTful API 的 NodeJS 封装，以简化调用方式和提供 Typescript 类型系统。

其中请求库是使用的 axios，重试库使用 async-retry。

Install

npm install --save tgit-api

Usage

const tgitApi = require('tgit-api');

const api = tgitApi(token, requestOptions, {
    retries: 5,
    onRetry: (e, attemptNo) => {
        console.log(`
            Tgit API retry: this is the ${attempt} time.
            Error message: ${e.message}
            API url: ${e.config.url}
        `);
    }
}, {
    baseURL: "https://git.code.tencent.com/api/v3"
})

tgitApi.catch = async (err) => {
    const status = err.response && err.response.status;
    if (status === 401) {
        // Unauthorized 
        // Fetch a new token and retry
        tgitApi.token = await getTGitToken();
    }

    throw err;
};

;(async () => {
    const res = await api.projects({
        page: 1,
        per_page: 10,
        order_by: 'create_at',
        sort: 'asc'
    })
})()

// 可以运行时改变 token 的值
api.token = "another_token";

• token 必填参数，是工蜂提供的票据，可以是 private token，也可以是 OAuth2 的 access_token。

• requestOptions 可选参数，是会透传给 axios 请求库的，相关参数 API 可以在这里查询。其中 url、method、data 参数请不要传，仓库内已经适配好，只需按需修改其他参数即可，如 timeout 等。

• retryOptions 可选参数，如果不传则默认不重试。

  • retries：最大重试次数。默认值为 10。
  • factor：指数因子。默认值为 2。
  • minTimeout：距第一次重试间隔（毫秒）。默认值为 1000。
  • maxTimeout：两次重试间最大时长。默认值为 Infinity。
  • randomize：是否在 1 到 2 间随机选择指数因子。默认值为 true。
  • onRetry：重试实施后的回调函数，可选。回调函数的第一个参数是上一次尝试失败抛出的错误信息。

0.15.3 升级 0.16.0 及以上

需要在初始化的时候，加上 baseURL 参数：

0.15.3 调用方式

tgitApi(token)

0.16.0 调用方式

tgitApi(token, undefined, undefined, {
    baseURL: "path_to_api"
})

0.65.0 及以上

支持在初始化的时候，传入 axios 实例：

import axios, { AxiosInstance, AxiosRequestConfig } from 'axios';

// 创建 axios 实例，配置太湖网关信息
const axiosInstance: AxiosInstance = axios.create({
    baseURL: 'https://api-s-idc.sgw.woa.com/ebus/gitcode/git_code_api/api/v3',
    // 请求超时时间
    timeout: 10000,
});

// 配置拦截器
axiosInstance.interceptors.request.use((config: AxiosRequestConfig) => {
    const timestamp = Math.ceil(Date.now() / 1000);
    const nonce = String(Math.ceil(Math.random() * 99999999));

    // 添加请求头
    config.headers.common['x-rio-paasid'] = 'your paasid';
    config.headers.common['x-rio-timestamp'] = timestamp;
    config.headers.common['x-rio-nonce'] = nonce;
    config.headers.common['x-rio-signature'] = 'sha256 signature';

    return config;
});

const api = tgitApi(token, null, null, {
    // 优先使用 axiosInstance 配置的 baseURL，所以这里可以传空或者不传
    baseURL: '',
    axiosInstance
});

API