API hub API: Nodejs Client

This library is considered to be in preview. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.

API hub API client for Node.js

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

• API hub API Nodejs Client API Reference
• API hub API Documentation

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

Table of contents:

• Quickstart

  • Before you begin
  • Installing the client library

• Versioning

• Contributing

• License

Quickstart

Before you begin

1. Select or create a Cloud Platform project.
2. Enable billing for your project.
3. Enable the API hub API API.
4. Set up authentication so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/apihub

Samples

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

| Sample | Source Code | | --------------------------- | --------------------------------- | | create api | source code | | create api operation | source code | | create attribute | source code | | create deployment | source code | | create external api | source code | | create spec | source code | | create version | source code | | delete api | source code | | delete api operation | source code | | delete attribute | source code | | delete deployment | source code | | delete external api | source code | | delete spec | source code | | delete version | source code | | get api | source code | | get api operation | source code | | get attribute | source code | | get definition | source code | | get deployment | source code | | get external api | source code | | get spec | source code | | get spec contents | source code | | get version | source code | | list api operations | source code | | list apis | source code | | list attributes | source code | | list deployments | source code | | list external apis | source code | | list specs | source code | | list versions | source code | | search resources | source code | | update api | source code | | update api operation | source code | | update attribute | source code | | update deployment | source code | | update external api | source code | | update spec | source code | | update version | source code | | collect api data | source code | | create curation | source code | | delete curation | source code | | get curation | source code | | list curations | source code | | update curation | source code | | create dependency | source code | | delete dependency | source code | | get dependency | source code | | list dependencies | source code | | update dependency | source code | | get discovered api observation | source code | | get discovered api operation | source code | | list discovered api observations | source code | | list discovered api operations | source code | | create plugin | source code | | create plugin instance | source code | | delete plugin | source code | | delete plugin instance | source code | | disable plugin | source code | | disable plugin instance action | source code | | enable plugin | source code | | enable plugin instance action | source code | | execute plugin instance action | source code | | get plugin | source code | | get plugin instance | source code | | list plugin instances | source code | | list plugins | source code | | update plugin instance | source code | | create host project registration | source code | | get host project registration | source code | | list host project registrations | source code | | get style guide | source code | | get style guide contents | source code | | lint spec | source code | | update style guide | source code | | create api hub instance | source code | | delete api hub instance | source code | | get api hub instance | source code | | lookup api hub instance | source code | | create runtime project attachment | source code | | delete runtime project attachment | source code | | get runtime project attachment | source code | | list runtime project attachments | source code | | lookup runtime project attachment | source code | | cloud | source code |

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/apihub@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template.

License

Apache Version 2.0

See LICENSE