API Gateway: Node.js Client

Apigateway client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG .

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained .

Table of contents:

Quickstart
Samples
Versioning
Contributing
License

Quickstart

Before you begin

Select or create a Cloud Platform project .
Enable billing for your project .
Enable the API Gateway API .
Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

 npm install @google-cloud/api-gateway

Using the client library

 /**
 * TODO(developer): Uncomment these variables before running the sample.
 */
// const projectId = 'my-project';
const {ApiGatewayServiceClient} = require(' @google-cloud/api-gateway 
');
const client = new ApiGatewayServiceClient 
();
async function listApis() {
  const [apis] = await client.listApis({
    parent: `projects/${projectId}/locations/global`,
  });
  for (const api of apis) {
    console.info(`name: ${api.name}`);
  }
}
listApis();

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

Sample	Source Code	Try it
Api_gateway_service.create_api	source code
Api_gateway_service.create_api_config	source code
Api_gateway_service.create_gateway	source code
Api_gateway_service.delete_api	source code
Api_gateway_service.delete_api_config	source code
Api_gateway_service.delete_gateway	source code
Api_gateway_service.get_api	source code
Api_gateway_service.get_api_config	source code
Api_gateway_service.get_gateway	source code
Api_gateway_service.list_api_configs	source code
Api_gateway_service.list_apis	source code
Api_gateway_service.list_gateways	source code
Api_gateway_service.update_api	source code
Api_gateway_service.update_api_config	source code
Api_gateway_service.update_gateway	source code
Quickstart	source code
Quickstart.test	source code

The API Gateway Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule . Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

Legacy versions are not tested in continuous integration.
Some security patches and features cannot be backported.
Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags . The dist-tags follow the naming convention legacy-(version) . For example, npm install @google-cloud/api-gateway@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning .

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stablelibraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide .

Please note that this README.md , the samples/README.md , and a variety of configuration files in this repository (including .nycrc and tsconfig.json ) are generated from a central template. To edit one of these files, make an edit to its templates in directory .

License

Apache Version 2.0

See LICENSE