Documenting the public accessible portion of the National Hockey League's API (which is contracted out to MLBAM).
The site is live at steviehoward.com/NHL-API-docs
This is true Taco Bell Engineering*.
I had played around with the "old" undocumented NHL API for my Ticker project, and planned to write a crawler to probe and map out the API for the new [MLBAM] NHL API once I was finished Spring 2018 semester. Fortunately for me, @erunion and @dword4 had already done the work over that time period (January 2018). It didn't take long at all to assemble the pieces of this documentation and publish as a public webpage.
- Download Slate
- Initialize a git repository in Slate folder, setting this GitHub repository as
remote origin - Download NHL OpenAPI 3.0 specification file
- Use Widdershins to convert OpenAPI YAML to Markdown
- Copy-paste Markdown into Slate
- Deploy Slate to GitHub Pages
I added basically nothing to this project. All credit should go to those mentioned here:
- @dword4 for [manual!] data discovery, documentation
- @erunion for data processing, formatting, documentation
- @lord for Slate
- @mermade for Widdershins
- Use git submodules to pull in any changes to component projects
- Automate updates via CI build system
*From Taco Bell Programming