Skip to main content

API specification for the Boids application

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

boids_api-0.0.1687298655.tar.gz (17.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

boids_api-0.0.1687298655-py2.py3-none-any.whl (37.0 kB view details)

Uploaded Python 2Python 3

File details

Details for the file boids_api-0.0.1687298655.tar.gz.

File metadata

  • Download URL: boids_api-0.0.1687298655.tar.gz
  • Upload date:
  • Size: 17.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.1 CPython/3.11.4

File hashes

Hashes for boids_api-0.0.1687298655.tar.gz
Algorithm Hash digest
SHA256 3c6f1ffb0f7893f5c1e93f28690d80a367a17085b0177f8f92785080968e3210
MD5 e3b4a08ea74531ec23352ad2b9f5877c
BLAKE2b-256 c25aeaf1c03e6f1f8ef34e233b13414636ef539a810a2a3b8a8c9042411f8367

See more details on using hashes here.

File details

Details for the file boids_api-0.0.1687298655-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for boids_api-0.0.1687298655-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c4fb2815d498b8727ae7c7fe19406161ad53d9d4eac5ac9bbb46081f95b47ff1
MD5 851f2d76aea2ba5914f2617cd0cf0f34
BLAKE2b-256 cc5a964496d8b17aa150fbb13f0d0a71401ebec46141ccbefba8475bc72ba878

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page