shouhuola v0.0.2

API网关SDK使用指南

• API 更新日期: 2019-12-03 16:32:12
• SDK 创建日期: 2019-12-03T16:50:35.577+08:00

Shouhuola - JavaScript client for shouhuola

##目录

• 一、SDK简介
• 二、SDK安装
• 三、本SDK的API信息

一、SDK简介

本SDK是API网关根据您自定义的API接口自动生成的 Javascript 调用代码，通过使用SDK，您可以更方便地访问腾讯云提供的API网关服务。下面向您介绍如何使用API网关的SDK。

主要文件的层级结构如下：

• src/ 目录
  • api/ 目录 包含用户自定义的所有API接口
  • ApiClient.js
  • index.js
• docs/ 目录 存放API接口文档
• README.md 本SDK使用指南
• swagger.json 包含所有API定义的swagger文件，您可以用此文件在这里调试您的API

二、SDK安装

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 shouhuola --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 shouhuola from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('shouhuola') 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 Shouhuola = require('shouhuola');

var api = new Shouhuola.ShouhuolaApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getApiV1Test(callback);

三、本SDK的API信息

收货啦API网关

• 默认域名： service-rv1tjash-1255757638.ap-shanghai.apigateway.myqcloud.com/test
• 自定义域名： api1.haoduizhang.net/test

All URIs are relative to http://service-rv1tjash-1255757638.ap-shanghai.apigateway.myqcloud.com/test

更多详细信息请查看docs下的API文档