Announcement_Service/gen
Justin Weins 07d201d3ae init commit 2025-03-25 14:41:53 +01:00
..
.github/workflows init commit 2025-02-13 11:29:07 +01:00
.openapi-generator init commit 2025-03-25 14:41:53 +01:00
docs init commit 2025-02-13 11:29:07 +01:00
openapi_client init commit 2025-02-13 11:29:07 +01:00
openapi_server init commit 2025-03-25 14:41:53 +01:00
test init commit 2025-02-13 11:29:07 +01:00
.dockerignore init commit 2025-02-13 11:29:07 +01:00
.gitignore init commit 2025-02-13 11:29:07 +01:00
.gitlab-ci.yml init commit 2025-02-13 11:29:07 +01:00
.openapi-generator-ignore init commit 2025-03-25 14:41:53 +01:00
.travis.yml init commit 2025-03-25 14:41:53 +01:00
README.md init commit 2025-03-25 14:41:53 +01:00
entrypoint.sh init commit 2025-03-25 14:41:53 +01:00
git_push.sh init commit 2025-02-13 11:29:07 +01:00
pyproject.toml init commit 2025-02-13 11:29:07 +01:00
requirements.txt init commit 2025-03-25 14:41:53 +01:00
setup.cfg init commit 2025-02-13 11:29:07 +01:00
setup.py init commit 2025-03-25 14:41:53 +01:00
test-requirements.txt init commit 2025-03-25 14:41:53 +01:00
tox.ini init commit 2025-03-25 14:41:53 +01:00

README.md

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 openapi_server

and open your browser to here:

http://localhost:8080/ui/

Your OpenAPI definition lives here:

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

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