# API Specification

The specification is written using [Swagger 2.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md) (known today as OpenAPI).

# How to

## Preview a local specification file

Serve the content of this directory through any HTTP server, for instance:

```
$ python -m SimpleHTTPServer
Serving HTTP on 0.0.0.0 port 8000 ...
```

```
$ python3 -m http.server
Serving HTTP on 0.0.0.0 port 8000 ...
```

Then, browse your localhost on port 8000.


## Preview a specification file hosted on a remote machine

- Visit https://rebilly.github.io/ReDoc/
- Provide a URL to the spec file
- Click on 'TRY IT'
