Skip to content
Snippets Groups Projects
README.md 1.09 KiB
Newer Older
Jorge Moratinos's avatar
Jorge Moratinos committed
# OpenAPI generated server

## Overview
This server was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the
[OpenAPI-Spec](https://openapis.org) from a remote server, you can easily generate a server stub.  This
is an example of building a OpenAPI-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
torrespel's avatar
torrespel committed
python3 -m openapi_server
Jorge Moratinos's avatar
Jorge Moratinos committed
```

and open your browser to here:

```
http://localhost:8080/api-invocation-logs/v1/ui/
```

Your OpenAPI definition lives here:

```
http://localhost:8080/api-invocation-logs/v1/openapi.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 api_invocation_logs .

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