Skip to content

Documentation for the Bullhorn REST API

License

Notifications You must be signed in to change notification settings

bullhorn/rest-api-docs

Repository files navigation

Bullhorn Rest API Docs

These docs use Slate to convert markdown files into the Bullhorn Rest API Docs Site.

Prerequisites

You're going to need:

  • Linux or OS X — Windows may work, but is unsupported.
  • Ruby, version 1.9.3 or newer
  • Bundler — If Ruby is already installed, but the bundle command doesn't work, just run gem install bundler in a terminal.

Getting Set Up

# either run this to run locally
bundle install
bundle exec middleman server

# OR run this to run with vagrant
vagrant up

You can now see the docs at http://localhost:4567. Whoa! That was fast!

Now that Slate is all set up your machine, you'll probably want to learn more about editing Slate markdown, or how to publish your docs.

Generating Documentation

Import Code Generation.postman_collection.json to postman

Paste in your current documentation to pre-request scripts (or specify the new entity)

View your postman console to copy the new documentation

About

Documentation for the Bullhorn REST API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published