apigee-api

Typescript/Javascript node/browser compatible library for interacting with the Apigee Management API.

Usage

Install library as project dependency:

npm install apigee-api --save

Typescript

import { ApigeeClient, ApigeeClientConfig } from 'apigee-api';

// create a new client
const config: ApigeeClientConfig = {
    endpoint: 'https://api.enterprise.apigee.com',
    version: 'v1',
    username: 'myusername',
    password: 'mypassword',
    organization: 'myorg',
    environment: 'myenv'
};

const client = new ApigeeClient(config);

// use promises
client.proxies().list().then(proxies => console.log(proxies));

// or use async/await
const func = async () => {
    const proxies = await client.proxies().list();
    console.log(proxies);
};

func();

Javscript ES6

const apigee = require('apigee-api');

// create a new client
const config = {
    endpoint: 'https://api.enterprise.apigee.com',
    version: 'v1',
    username: 'myusername',
    password: 'mypassword',
    organization: 'myorg',
    environment: 'myenv'
};

const client = new apigee.ApigeeClient(config);

// use promises
client.proxies().list().then(proxies => console.log(proxies));

Development

1. Fork the repo
2. Clone your fork

Requirements

• nvm for Node version management
  • brew install nvm
  • .nvmrc file will be used to download and load the correct Node environment automatically
• Visiual Studio Code for editing and debugging
  • brew cask install visual-studio-code

Testing

1. Run the following command to auto compile source code into lib/:
   • npm run build
2. Create a config file for the tests to use:
   • cp config/test.json.example config/test.json
3. Run npm test or npm run test to run all tests under test/
4. Debug in VScode (See Debugging Section)

Debugging

The Visual Studio Code Editor is utilized to provide debugging functionality during testing. A task is provided under .vscode/ which takes care of running the tests in debug mode. Simply place a break point anywhere in the tests or library code and start debugging (use the Debug menu in VSCode).