Giter Club home page Giter Club logo

api-docs's Introduction

TradeStation API Docs

Build Status

This repo is used to document the TradeStation API using Open API Specificiation (AKA Swagger 2.0).

Purpose

  • 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)

Getting Started

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.

Developer Workflow

Install

  1. Install Node JS
  2. Clone repo and cd
    • Run npm install

Usage

  1. Run npm start
  2. Checkout console output to see where local server is started.
  3. Make changes using your favorite editor or swagger-editor (look for URL in console output)
    • Review the [Style guide](CONTRIBUTING.md#style guide).
  4. 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 and swagger-ui in parallel
  5. Once you finish with the changes you can run tests using: npm test
  6. Share you changes with the rest of the world by pushing to GitHub ๐Ÿ˜„

Links

Warning: All above links are updated only after Travis CI finishes deployment

Recommended Tools

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.