https://github.com/bttmly/nba-client-template
JSON file to be used for generating NBA API clients
https://github.com/bttmly/nba-client-template
Last synced: 17 days ago
JSON representation
JSON file to be used for generating NBA API clients
- Host: GitHub
- URL: https://github.com/bttmly/nba-client-template
- Owner: bttmly
- Created: 2016-07-15T03:52:34.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-12-06T10:22:40.000Z (over 1 year ago)
- Last Synced: 2025-04-04T18:21:54.600Z (about 1 month ago)
- Language: Go
- Size: 58.6 KB
- Stars: 49
- Watchers: 6
- Forks: 20
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# nba-client-template
nba.com API endpoints encoded as JSON for easy client library development.
## notice
It appears that nba.com is in the process of slowly retiring the stats.nba.com/stats endpoints in favor of a new data.nba.com/data API. I plan to add those endpoints to this project at some point.
## info
This repo holds a JSON file that can be used to programmatically generate a client for the NBA's stats API. Since it's JSON, it should be trivially parseable by any language. It's currently published as an NPM module, but if you want it packaged up for your language of choice as well, please open an [issue](https://github.com/bttmly/nba-client-template/issues) or better yet, a [pull request](https://github.com/bttmly/nba-client-template/pulls). Thanks!
The file contains two primary parts: endpoints and parameters. Endpoints should generally be mapped to methods on an API client. Each endpoint has a list of parameters that it accepts. Parameter objects hold some data about individual parameters -- specifically, what the parameter is called (`name`), its known values (`values`), its default value (`default`), and a boolean (`enumerated`) indicating whether its listed values encompass all valid values. These can be used to implement parameter validation.
The simplest and probably easiest implementation is to map each endpoint to a function accepting a single argument, that being a hash of `{parameter: value}`. To provide some examples in code, the `examples` folder contains three _very_ simple client implementations in Python, Ruby, and Go. The Python and Ruby examples are implemented pretty much the same way, and while they are certainly not idiomatic in the respective languages, they should illustrate the general idea. For languages without highly dynamic reflection features, code generation might be used to create a client. The Go example illustrates how that might work -- using Go to generate a Go file.
A full-featured Node.js client based on this template can be seen at [bttmly/nba](https://github.com/bttmly/nba).