Skip to content
This repository was archived by the owner on Jul 14, 2022. It is now read-only.

Apigee 127 modules

Jump to bottom
wwitman edited this page Sep 4, 2014 · 8 revisions

#Apigee 127 modules and dependencies

This topic describes the Node.js modules on which an Apigee 127 project depends. In general, each of the modules includes a README file on npmjs.org or GitHub, and we'll provide links below for each one.

##apigee-127

The apigee-127 module provides everything you need to create new Apigee 127 projects, including the Swagger editor, Swagger Tools middleware, sample project skeleton, Volos.js, Usergrid, and the a127 command-line tools.

###Installation For installation instructions, see "Installation".

###Documentation

The main source of documentation for Apigee 127 is the [Apigee 127 documentation wiki(https://github.com/apigee-127/a127-documentation/wiki) on GitHub.

Here are direct links to the command-line tool and example project docs:

Dependencies

This is a snapshot of the apigee-127 dependencies listed in the module's package.json file. This is a sample only and dependencies and versions are subject to change.

Note: Dependencies that are specific to Apigee 127, such as swagger-tools and volos are described below.

  "dependencies": {
      "apigee-access": "1.0.x",
      "apigeetool": "",
      "async": "0.8.x",
      "commander": "2.3.x",
      "debug": "1.0.x",
      "express": "4.8.x",
      "fs-reverse": "0.0.x",
      "inquirer": "0.5.x",
      "lodash": "2.4.x",
      "ncp": "0.6.x",
      "nodemon": "1.2.x",
      "skeleton": "git://github.com/apigee-127/project-skeleton.git#master",
      "swagger-editor-for-apigee-127": "2.x.x",
      "swagger-tools": "^0.5.2",
      "tail": "0.3.x",
      "usergrid-installer": "0.0.x",
      "volos": "git://github.com/apigee-127/volos.git#master",
      "yamljs": "0.1.x"
 }

apigee-access

The apigee-access module allows Node.js applications running on the Apigee Edge platform a way to access Apigee-specific functionality. You can use this module to:

  • Access and modify "flow variables" within the Apigee message context.
  • Retrieve sensitive data from the the secure store.
  • Use the built-in distributed cache.
  • Use the built-in distributed quota service.
  • Use the OAuth service.

###Installation

Standard npm install. Installed with apigee-127.

###Documentation

See the apigee-access README on GitHub.

skeleton

A basic, "hello world" Apigee 127 project. This project automatically cloned when you create a new Apigee 127 project by executing a127 project create.

Installation

This project is cloned from GitHub when you create a new Apigee 127 project.

Documentation

See the Apigee 127 "Quick start" to see how easy it is to get a new Apigee 127 API project up and running.

swagger-editor-for-apigee-127

The Swagger Editor for Apigee 127 lets you design your API specification and interactively preview its documentation for your Apigee 127 API project.

###Installation

Standard npm install. Installed with Apigee 127.

###Documenation

See "Understanding Swagger" on the Apigee 127 doc wiki for details about the editor.

swagger-tools

Middleware for Node.js including Message Validation, Authorization and Routing.

###Installation

Standard npm install. Installed with Apigee 127.

###Documenation

See the swagger-tools README on GitHub.

See also the Twitter search example on Apigee 127 to see how the x-swagger-router-controller Swagger extension, based on swagger-tools, is used for API endpoint routing in an Apigee 127 project.

Swagger Tools middleware components

Swagger tools provides these middleware comnponents. They provide services for message validation, authorization, and routing.

  • swagger-metadata
  • swagger-router
  • swagger-validator

usergrid-installer

This module is designed to download a the version of Usergrid assigned in the package.json usergrid section. It was designed to allow the "embedding" of Usergrid within Apigee-127, but could potentially be used by other apps.

Installation

Standard npm install. Installed with Apigee 127.

###Documentation

See the usergrid-installer README on npmjs.org.

##volos

TBD

##Installation

Standard npm install. Installed with Apigee 127

###Documentation

TBD

Modules included with Volos.js

  * quota/memory/volos-quota-memory
  * quota/redis/volos-quota-redis
  * quota/apigee/volos-quota-apigee
 
     * pointer to apigee-remote-proxy on github
  * cache/memory/volos-cache-memory
  * cache/redis/volos-cache-redis
  * cache/apigee/volos-cache-apigee

#Other related modules

a127-magic

TBD

Installation

Standard npm install. Installed when you create a new Apigee 127 project.

###Documentation

See the README file on npmjs.org.

volos-swagger

Drives volos through configuration

##Installation

Standard npm install. Installed when you create a new Apigee 127 project.

##Documentation

See the README on npmjs.org.

Having Trouble? Try posting your question to the Apigee Community. Or, for more links and resources, check out our Help Page

Contents

Need help? Visit the Apigee Community !
Clone this wiki locally