The missing library of functions for administering Apigee Edge from nodejs.
This library helps you do that.
Example:
To create a new developer account:
var edgejs = require('apigee-edge-js'),
common = edgejs.utility,
apigeeEdge = edgejs.edge;
var options = {
mgmtServer: config.mgmtserver,
org : config.org,
user: config.username,
password: config.password
};
apigeeEdge.connect(options, function(e, org){
if (e) {
console.log(e);
console.log(e.stack);
process.exit(1);
}
common.logWrite('connected');
var options = {
developerEmail : "JDimaggio@example.org",
lastName : "Dimaggio",
firstName : "Josephine",
userName : "JD1",
attributes: { "uuid": uuidV4() }
};
org.developers.create(options, function(e, result){
if (e) {
utility.logWrite(JSON.stringify(e));
process.exit(1);
}
utility.logWrite(sprintf('ok. developer: %s', JSON.stringify(result, null, 2)));
});
});You can also tell the library to read credentials from .netrc :
var edgejs = require('apigee-edge-js'),
utility = edgejs.utility,
apigeeEdge = edgejs.edge;
var options = { org : config.org, netrc: true };
apigeeEdge.connect(options, function(e, org){
...
});This library and the example tools included here are not an official Google product. Support is available on a best-effort basis via github or community.apigee.com .
To start, you call apigeeEdge.connect(). This will connect to an Edge organization. If it is a SaaS organization, this method will try to find a stashed OAuth token and if not will get an OAuth token. The callback will return (e, org), where e is an error, possibly null, and org is an Organization object with these members. Each is itself a hash and has child members as functions:
| member | functions |
|---|---|
| environments | get, getVhosts |
| proxies | get, del, deploy, undeploy, import, export, getRevisions, getDeployments, getResourcesForRevision, getPoliciesForRevision, getProxyEndpoints |
| caches | get, create, del |
| kvms | get, create, put, del |
| sharedflows | get, del, deploy, undeploy, import, export, getRevisions, getDeployments, getResourcesForRevision, getPoliciesForRevision |
| flowhooks | get, put |
| products | get, create, del |
| developers | get, create, del |
| keystores | get, create, del, import key and cert |
| developerapps | get, create, del |
| appcredentials | add, del |
| audits | get |
As you can see from the function list above, pretty much all the basic stuff you want to do with Apigee Edge administration is here. There are some gaps but those are being filled in as need arises.
You can examine the lib/edge.js file to see the full list of operations. Or see the examples directory for some example code. A few examples are shown here.
Pull requests are welcomed, for the code or for examples.
edgeOrg.proxies.export({name:'proxyname'}, function(e,result) {
if (e) {
console.log("ERROR:\n" + JSON.stringify(e, null, 2));
return;
}
fs.writeFileSync(path.join('/Users/foo/export', result.filename), result.buffer);
console.log('ok');
});edgeOrg.proxies.export({name:'proxyname', revision:3}, function(e,result) {
if (e) {
console.log("ERROR:\n" + JSON.stringify(e, null, 2));
return;
}
fs.writeFileSync(path.join('/Users/foo/export', result.filename), result.buffer);
console.log('ok');
});var options = {
mgmtServer: mgmtserver,
org : orgname,
user: username,
password:password
};
apigeeEdge.connect(options, function(e, org){
if (e) {
console.log(JSON.stringify(e, null, 2));
process.exit(1);
}
org.proxies.import({name:opt.options.name, source:'/tmp/path/dir'}, function(e, result) {
if (e) {
console.log('error: ' + JSON.stringify(e, null, 2));
if (result) { console.log(JSON.stringify(result, null, 2)); }
process.exit(1);
}
console.log('import ok. %s name: %s r%d', term, result.name, result.revision);
});var options = {
name: 'proxy1',
revision: 2,
environment : 'test'
};
org.proxies.deploy(options, function(e, result) {
if (e) {
console.log(JSON.stringify(e, null, 2));
if (result) { console.log(JSON.stringify(result, null, 2)); }
return e;
}
console.log('deploy ok.');
});
org.proxies.getRevisions({name:'proxyname-here'}, function(e, result){
if (e) {
console.log("ERROR:\n" + JSON.stringify(e, null, 2));
return;
}
console.log('revisions: ' + JSON.stringify(result)); // eg, [ "1", "2", "3"]
var latestRevision = result[result.length-1];
});
var async = require('async');
analyzeOneProxy(proxyName, callback) {
collection.get({ name: proxyName }, function(e, result) {
console.log(JSON.stringify(result));
});
}
org.proxies.get({}, function(e, proxies) {
if (e) {
console.log("ERROR:\n" + JSON.stringify(e, null, 2));
return;
}
async.mapSeries(proxies, analyzeOneProxy, function (e, proxyResults) {
if (e) {
console.log("ERROR:\n" + JSON.stringify(e, null, 2));
return;
}
var flattened = [].concat.apply([], proxyResults);
console.log(JSON.stringify(flattened, null, 2));
});
});
var options = {
environment : 'test',
name : 'keystore1'
};
org.keystores.create(options, function(e, result){
if (e) { ... }
console.log('ok. created');
options.certFile = './mycert.cert';
options.keyFile = './mykey.pem';
options.alias = 'alias1';
options.keyPassword = 'optional password for key file';
org.keystores.importCert(options, function(e, result){
if (e) { ... }
console.log('ok. key and cert stored.');
});
});
See the examples directory for a set of working example tools.
To run tests you should create a file called testConfig.json and put it in the toplevel dir of the repo. It should have contents like this:
{
"org" : "my-org-name",
"user": "username@example.com",
"password": "password-goes-here",
"verbosity": 1
}or:
{
"org" : "my-org-name",
"netrc": true
}The latter example will retrieve credentials from .netrc.
Then, to run tests:
npm testor
node_modules/mocha/bin/mocha
This code is Copyright (C) 2017-2018 Google LLC, and is licensed under the Apache 2.0 source license.
- The tests are incomplete
See also, this Powershell module