forked from loafle/openapi-generator-original
80ca67cfda
* Astract factory for generators based on connexion * Add aiohttp server generator * Fix flask tests * Normalize python-flask folder names
49 lines
1.0 KiB
Markdown
49 lines
1.0 KiB
Markdown
# OpenAPI generated server
|
|
|
|
## Overview
|
|
This server was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the
|
|
[OpenAPI-Spec](https://openapis.org) 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](https://github.com/zalando/connexion) library on top of Flask.
|
|
|
|
## Requirements
|
|
Python 2.7+
|
|
|
|
## Usage
|
|
To run the server, please execute the following from the root directory:
|
|
|
|
```
|
|
pip install -r requirements.txt
|
|
python -m openapi_server
|
|
```
|
|
|
|
and open your browser to here:
|
|
|
|
```
|
|
http://localhost:8080/v2/ui/
|
|
```
|
|
|
|
Your OpenAPI definition lives here:
|
|
|
|
```
|
|
http://localhost:8080/v2/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:
|
|
|
|
```bash
|
|
# building the image
|
|
docker build -t openapi_server .
|
|
|
|
# starting up a container
|
|
docker run -p 8080:8080 openapi_server
|
|
``` |