Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Interactive API documentation system
JavaScript
branch: master

This branch is 25 commits ahead, 144 commits behind mashery:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
public
views
.gitignore
LICENSE
Procfile
README.md
app.js
config.json
config.json.sample
package.json

README.md

Stormpath I/O Docs

Interactive documentation for Stormpath's REST API

Forked from Mashery's I/O Docs: https://github.com/mashery/iodocs

Use an SDK, if you can

If you're using one of the following languages, you probably want the SDK instead of the REST API. The SDKs are more secure and easier to use.

Java
PHP
Ruby
Python

Download an API Key

Signup for Stormpath and download an API Key to $HOME/.stormpath/apiKey.properties (steps 1 and 2 here)

Generate a yaml version of the properties file for the I/O Docs app to read (the Ruby and Python SDKs also read from a yaml file)

cp $HOME/.stormpath/apiKey.properties $HOME/.stormpath/apiKey.yml
chmod go-rwx $HOME/.stormpath/apiKey.yml
sed -ie 's/=/:/g' $HOME/.stormpath/apiKey.yml

Install Build/Runtime Dependencies

Note: Node and some of the modules require compiler (like gcc). If you are on a Mac, you will need to install XCode. If you're on Linux, you'll need to install build-essentials, or something equivalent.

  1. Node.js - https://github.com/joyent/node/wiki/Installation
  2. npm (Node package manager) - https://github.com/isaacs/npm
  3. Redis - http://redis.io/download

TODO: rip out the Redis dependency

Install the Stormpath I/O Docs app

git clone http://github.com/DanMeyer/iodocs.git
cd iodocs
npm install

Tell the app where the API key lives

echo -n $HOME/.stormpath/apiKey.yml > apiKeyFilename

Run it

node ./app.js

Point your browser to: http://localhost:3000

More info

Official documentation
http://www.stormpath.com/docs#RESTAPIDocs

Les' 90 minute talk on RESTful API design
http://www.youtube.com/watch?v=hdSrT4yjS1g

Why use an API key?
http://www.stormpath.com/blog/top-six-reasons-use-api-keys-and-how

Something went wrong with that request. Please try again.