Interactive API documentation system
JavaScript CSS HTML
Pull request Compare This branch is 255 commits ahead, 2 commits behind mashery:master.
Latest commit a05bac0 Jan 13, 2017 @cshuptrine cshuptrine committed on GitHub Wording Updates
Permalink
Failed to load latest commit information.
public Wording Updates Jan 13, 2017
views Update Nav/Footers Jan 13, 2017
.gitignore
LICENSE
Makefile Makefile; README updates Jan 6, 2016
Procfile Revert "apparently app.js can't be named that" Jan 6, 2016
README-Original.md Create an Adzerk-specific README. May 20, 2015
README.md clearer prod deploy instructions May 24, 2016
app.js native ads - includePricingData Jun 3, 2016
config.json.sample Remove basic auth and redis config; set debug to true. Jun 3, 2015
package.json

README.md

Adzerk API Explorer via I/O Docs

Adzerk has forked the great I/O Docs tool from Mashery to create our API Explorer tool, named Ratatoskr.

Please read the README-Original.md for more details on I/O Docs.

Setup

brew install node
git clone git@github.com/adzerk/ratatoskr.git
cd ratatoskr
npm install

Run it

make run

Style it

Use Sass to restyle the docs, and only edit the .scss files that are compiled.

sass --watch public/stylesheets/scss:public/stylesheets/css --style compressed

This just sets a couple of necessary environment variables and runs npm start for you.

Then point your friendly, neighborhood browser at http://localhost:3000.

Develop it

Updating the Adzerk API Config

Edit the public/data/adzerk*.json files.

Hacks

We have some hacks in place to make iodocs play nice with the Adzerk API. These are in app.js. You'll find them if you grep around for "adzerk" and/or "hacks".

Deploy it

The Adzerk API Explorer is deployed to Elastic Beanstalk.

You can see it in action at: http://api-explorer.adzerk.com

Requirements

How to Do It

  • (first time only) Initialize the eb tool.
    • In this directory, run eb init --region=us-east-1.
    • It will ask for your AWS access and secret keys, unless they are already defined in your environment.
    • Choose api-explorer from the available environments.
  • Make changes and commit them via git.
  • Choose the production environment by running eb use api-explorer-env.
  • Run eb deploy.

Staging Deploy

If the changes you're making are more involved and/or require QA before deploying to production, you might want to consider deploying to the staging environment first.

The staging environment is deployed to: https://api-explorer-staging.adzerk.com

You can set the environment to which you want to deploy via eb use:

eb use api-explorer-staging

Then deploy like you would to production:

eb deploy

You may want to eb use api-explorer-env afterwards to switch back to the production environment, in order to avoid confusion the next time you want to deploy to production.