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

Quick start

jwest-apigee edited this page Sep 10, 2014 · 19 revisions

The purpose of this Quick Start is to show you how easily and quickly you can get a simple API up and running using Apigee-127.

First steps

  1. $ npm install -g apigee-127 (as described in Installation).
  2. Create a root folder for your Apigee 127 projects and cd to that folder.
  3. Execute: a127 project create hello-world. This will clone a project skeleton from GitHub into a directory from the working directory named hello-world. It will then run npm install to download dependencies for the project. Windows Users please see the note below regarding npm
  4. Change to the hello-world directory by typing $ cd hello-world
  5. Type $ a127 project start to start your API. You now have an API running with Apigee-127!
  6. In another terminal, run: $ curl http://localhost:10010/hello?name=Me. You should see the response Hello, Me.

That's it - You have now created, started and tested your first API project with Apigee-127!

To understand what happens behind the scenes see: [Quick Start Deep Dive] (https://github.com/apigee-127/a127-documentation/wiki/Quick-start-deep-dive)

Next steps

Windows Users

For some versions of npm on Windows will have problems on the npm install step of a127 project create. They are related to a debug module on npm not being managed properly. The following steps should resolve this issue:

  1. In the project directory, execute the following commands:
  2. npm install yamljs
  3. npm install debug
  4. npm install swagger-tools

Now, when you run a127 project start your project should start successfully.

Clone this wiki locally