thefirstalpha / testing-api

An API that manage multiple endpoint behind unique transaction

Testing API

Overview

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

and open your browser to here:

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

Your Swagger definition lives here:

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

# building the image
docker build -t api .

# starting up a container
docker compose up

Setup database

Some initial parameters is needed for the database. Once the database is initiated, you can use the 'database.sql' file to generate the tables and import the required data