This repo is used to document the TradeStation API using Open API Specificiation (AKA Swagger 2.0).
- To generate rich API documentation for API consumers to discover and learn how to use the TradeStation API
- To simplify how API creators design and publish new TradeStation API's (preferably in a contract-first manner)
Creating documentation is easy!
Just navigate to the spec
folder and edit the Open API swagger.yaml
.
The specification is composed using Open API Specificiation v2.0 (fka Swagger) syntax & rules.
Text within description
blocks use Github-flavored Markdown.
Once you are done, follow the steps below to Build & Publish.
- Install Node JS
- Clone repo and
cd
- Run
npm install
- Run
- Run
npm start
- Checkout console output to see where local server is started.
- Make changes using your favorite editor or
swagger-editor
(look for URL in console output)- Review the [Style guide](CONTRIBUTING.md#style guide).
- All changes are immediately propagated to your local server.
- All documentation pages will be automagically refreshed in a browser after each change
- TIP: you can open
swagger-editor
, documentation andswagger-ui
in parallel
- Once you finish with the changes you can run tests using:
npm test
- Share you changes with the rest of the world by pushing to GitHub ๐
- SwaggerUI: https://tradestation.github.io/api-docs/swagger-ui/
- Look full spec:
- Preview spec version for branch
[branch]
: https://tradestation.github.io/api-docs/preview/[branch]
Warning: All above links are updated only after Travis CI finishes deployment
- Text-Editor: VSCode
- Plugins: