Best Buy API Documentation
This project is the public home for the source that will eventually generate the API documentation for Best Buy's API. It will be served at https://developer.bestbuy.com/documentation once it is production-ready, but for now is available at https://bestbuyapis.github.io/api-documentation/.
The documentation is powered by the fantastic Slate project, an API documentation generator that is open source and very popular.
In the spirit of being a public API, we've chosen to publicize the generators that create our documentation. By doing this we hope to be more transparent when we make changes and provide a gateway for our consumers to become contributors.
Frequently Asked Questions
Where can I see the actual documentation?
You'll want to go to https://bestbuyapis.github.io/api-documentation/ for the compiled version. This project just shows the source code we used to generate it.
How do I get my API documentation to look as good as yours?
Check out Slate.
Where do I go to get an API key?
Go to https://developer.bestbuy.com and click "Get API Key"
How can I learn more about the Best Buy API?
Visit https://developer.bestbuy.com
Getting Started with the Best Buy API Documentation
Yes, this is identical to getting started with Slate.
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
bundlecommand doesn't work, just rungem install bundlerin a terminal.
Getting Set Up
- Fork this repository on Github.
- Clone your forked repository (not our original one) to your hard drive with
git clone https://github.com/YOURUSERNAME/api-documentation.git cd api-documentation- Install all dependencies:
bundle install - Start the test server:
bundle exec middleman server
You can now see the docs at http://localhost:4567.
Need Help? Found a bug?
You can either submit an issue or contact us.
Once your issue has been resolved, the Best Buy team will publish the documentation changes (using rake publish).