Swagger client generator. (#166)

This commit is contained in:
Travis Reeder
2016-10-14 11:40:20 -07:00
committed by GitHub
parent 6b7886721d
commit fcde29802e
6 changed files with 193 additions and 7 deletions

30
clients/README.md Normal file
View File

@@ -0,0 +1,30 @@
`build.rb` will generate all clients for all Swagger supported languages.
## Building and Deploying Clients
### First Time
If this is your first time building the clients, you'll need to do the following:
1) Install this single gem:
```sh
gem install http
```
2) Create a secret gist on Github and get an API token too.
### Every Time
Everytime the API spec is updated, be sure to bump the version number in `swagger.yml`, then run:
```sh
# The GITHUB_TOKEN, GITHUB_USERNAME and GIST_ID requirement is temporary, just used to automate the gist. Once this is public, we don't need the gist anymore.
GITHUB_TOKEN=X GITHUB_USERNAME=treeder GIST_ID=Y ruby build.rb
```
Boom. That's it.
## Troubleshooting
Sometimes this will fail due to github caching or something and versions will be off. Just bump version and retry.