us_central_gateway v1.2.4
us_central_gateway
UsCentralGateway - JavaScript client for us_central_gateway Sample API on API Gateway with a Google Cloud Functions backend This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen
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 us_central_gateway --save
git
If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/us_central_gateway then install it via:
npm install YOUR_USERNAME/us_central_gateway --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):
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 UsCentralGateway = require('us_central_gateway');
var defaultClient = UsCentralGateway.ApiClient.instance;
// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['key'] = "Token"
var api = new UsCentralGateway.DefaultApi()
api.hello().then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
Documentation for API Endpoints
All URIs are relative to https://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
UsCentralGateway.DefaultApi | hello | GET /hello-world | Greet a user |
Documentation for Models
Documentation for Authorization
api_key
- Type: API key
- API key parameter name: key
- Location: URL query string