https://github.com/TwineHealth/TwineDeveloperDocs

Documentation for developers using the Twine API
https://github.com/TwineHealth/TwineDeveloperDocs

Last synced: 5 months ago
JSON representation

Documentation for developers using the Twine API

• Host: GitHub
• URL: https://github.com/TwineHealth/TwineDeveloperDocs
• Owner: TwineHealth
• License: mit
• Archived: true
• Created: 2017-02-01T20:26:23.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2022-11-06T09:27:57.000Z (over 2 years ago)
• Last Synced: 2024-08-09T02:15:11.759Z (8 months ago)
• Language: JavaScript
• Size: 3.18 MB
• Stars: 9
• Watchers: 15
• Forks: 6
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - TwineHealth/TwineDeveloperDocs - Documentation for developers using the Twine API (JavaScript)

README

        
# Fitbit Plus OpenAPI Specification

[![Build Status](https://travis-ci.org/TwineHealth/TwineDeveloperDocs.svg?branch=master)](https://travis-ci.org/TwineHealth/TwineDeveloperDocs)

## Links

- Documentation(ReDoc): https://twinehealth.github.io/TwineDeveloperDocs/

- SwaggerUI: https://twinehealth.github.io/TwineDeveloperDocs/swagger-ui/

- Look full spec:

    + JSON https://twinehealth.github.io/TwineDeveloperDocs/swagger.json

    + YAML https://twinehealth.github.io/TwineDeveloperDocs/swagger.yaml

- Preview spec version for branch `[branch]`: https://twinehealth.github.io/TwineDeveloperDocs/preview/[branch]

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

## Working on specification

### Install

1. Install [Node JS](https://nodejs.org/)

2. Clone repo and `cd`

    + Run `npm install`

### Usage

1. Run `npm start`

2. Checkout console output to see where local server is started. You can use all [links](#links) (except `preview`) by replacing https://twinehealth.github.io/TwineDeveloperDocs/ with url from the message: `Server started `

3. Make changes using your favorite editor or `swagger-editor` (look for URL in console output)

4. All changes are immediately propagated to your local server, moreover 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 :smile: