developers.fliit.de

This is Fliit's public API docs website, hosted at developers.fliit.de.

Project Structure

• Swagger v2 specification
• ReDoc API doc generator

Run the docs locally with ReDoc

Run any local server one-liner on the root of this repo, such as:

$ ruby -run -e httpd . -p 9090
OR
$ python -m http.server 9090
OR
$ npm install -g node-static   # install dependency
$ static -p 9090
OR
$ php -S 127.0.0.1:9090
OR
https://gist.github.com/willurd/5720255

And open your browser at http://localhost:9090

Alternatively, run the docs locally with Swagger UI

$ docker pull swaggerapi/swagger-ui
$ docker run -p 9091:8080 -e SWAGGER_JSON=/bar/swagger.yml -v /path-to-this-repo:/bar swaggerapi/swagger-ui

Open http://0.0.0.0:9091 on your browser.

ReDoc dependency

Right now we are downloading the release file directly from Github and storing on version control directly instead of using a package manager.

Follow ReDoc releases for updates

Deploy

Make sure the $FLIIT_DEV_WEBSITE_BUCKET and $FLIIT_DEV_SITE_CLOUDFRONT_DIST_ID are set and run.

$ make deploy

The values that should be assigned to these env vars are available on the terraform output of devops repository. You can get them by running:

devops/terraform/base$ terraform output fliit_dev_website_export_env_var

And then execute the output as a command on your terminal.

Other important links:

• https://swagger.io/docs/specification/2-0/basic-structure/
• https://editor.swagger.io/

© 2017 Fliit. Licensed under terms of Apache License v2