boids-api 0.0.1687298275

API specification for the Boids application

OpenAPI generated server

Overview

This server was generated by the OpenAPI Generator project. By using the OpenAPI-Spec 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 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 boids_api

and open your browser to here:

http://localhost:8080/api/v1/ui/

Your OpenAPI definition lives here:

http://localhost:8080/api/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:

# building the image
docker build -t boids_api .

# starting up a container
docker run -p 8080:8080 boids_api