Skip to content
Snippets Groups Projects
README.md 1.33 KiB
Newer Older
Jan Müller's avatar
Jan Müller committed
# access-node
Jan Müller's avatar
Jan Müller committed
Public access server providing a REST API for the in-situ pipeline.
Jan Müller's avatar
Jan Müller committed

Jan Müller's avatar
Jan Müller committed
To generate execute this from the projects root dir:
```
Jan Müller's avatar
Jan Müller committed
java -jar swagger-codegen-cli-2.4.8.jar generate -i access_node/swagger/swagger.yaml -l python-flask -c config.json
Jan Müller's avatar
Jan Müller committed
```
Jan Müller's avatar
Jan Müller committed
# Swagger generated server

## Overview
This server was generated by the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project. By using the
[OpenAPI-Spec](https://github.com/swagger-api/swagger-core/wiki) from a remote server, you can easily generate a server stub.  This
is an example of building a swagger-enabled Flask server.

This example uses the [Connexion](https://github.com/zalando/connexion) library on top of Flask.

## Requirements
Python 3.5.2+

## Usage
To run the server, please execute the following from the root directory:

```
pip3 install -r requirements.txt
python3 -m access_node
```

and open your browser to here:

```
http://localhost:8080//ui/
```

Your Swagger definition lives here:

```
http://localhost:8080//swagger.json
```

To launch the integration tests, use tox:
```
sudo pip install tox
tox
```

## Running with Docker

To run the server on a Docker container, please execute the following from the root directory:

```bash
# building the image
docker build -t access_node .

# starting up a container
docker run -p 8080:8080 access_node
```