jackeytest v0.5.0
API网关SDK使用指南
- API 更新日期: 2018-08-06 03:15:59
- SDK 创建日期: 2018-08-15T11:17:21.519+08:00
Jackeytest - JavaScript client for jackeytest
SDK简介
本SDK是API网关根据您自定义的API接口自动生成的 Javascript 调用代码,通过使用SDK,您可以更方便地访问腾讯云提供的API网关服务。下面向您介绍如何使用API网关的SDK。
主要文件的层级结构如下:
- src/ 目录
- api/ 目录
包含用户自定义的所有API接口
- ApiClient.js
- index.js
- api/ 目录
- docs/ 目录
存放API接口文档
- README.md
本SDK使用指南
- swagger.json
包含所有API定义的swagger文件,您可以用此文件在
这里调试您的API
身份认证与签名计算
您需要准备一对授权密钥用于签名信息,您可以在腾讯云API网关管理控制台创建好一对 secret_id 和 secret_key。
然后根据 签名计算规则计算好签名信息。
签名计算方法请参考这里;另外,API文档中也有详细介绍签名计算规则和Demo代码。
注意:secret_id
和secret_key
是API网关认证用户请求合法性的密钥,这对秘钥如果保存在客户端,请妥善加密。
然后,根据计算出的签名信息,构造HTTP请求Header,可在 src/api/*.js
文件中设置Header参数。
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install jackeytest --save
Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing
into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
Finally, switch to the directory you want to use your jackeytest from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('jackeytest')
in javascript files from the directory you ran the last
command above from.
git
If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --save
For browser
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually
use this library):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Webpack Configuration
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
var Jackeytest = require('jackeytest');
var api = new Jackeytest.JackeytestApi()
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getHaha(callback);
API相关描述信息
jackeytest
- 默认域名: service-5f7nt6zq-1255429582.ap-guangzhou.apigateway.myqcloud.com/test
All URIs are relative to http://service-5f7nt6zq-1255429582.ap-guangzhou.apigateway.myqcloud.com/test
Class | API名称 | HTTP 请求方法与路径 | 描述 |
---|---|---|---|
Jackeytest.JackeytestApi | getHaha | GET /haha | null |