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 aiohttp server.

This example uses the Connexion library on top of aiohttp.

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 pytest:

sudo pip install -r test-requirements.txt
pytest

Prevent file overriding

After first generation, add edited files to .openapi-generator-ignore to prevent generator from overwriting them. Typically:

server/controllers/*
test/*
*.txt

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-1.0.3.tar.gz (15.1 kB view hashes)

Uploaded Source

Built Distribution

boids_api-1.0.3-py2.py3-none-any.whl (29.5 kB view hashes)

Uploaded Python 2 Python 3

Supported by

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