forked from loafle/openapi-generator-original
f3e3a724fb
* map free-form objects to Dict[str, Any] * support Forward Type References Forward type references will be supported by default from Python 3.10 on only. Until then (and starting with Python 3.7), we can opt in by a __future__ import, cf. https://docs.python.org/3.9/whatsnew/3.7.html?highlight=forward#pep-563-postponed-evaluation-of-annotations * re-created pet-store sample * bump required Python version to 3.7 for generated FastAPI projects * make pydantic modell classes process forward type references
39 lines
796 B
Markdown
39 lines
796 B
Markdown
# OpenAPI generated FastAPI server
|
|
|
|
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
|
|
- API version: 1.0.0
|
|
- Build package: org.openapitools.codegen.languages.PythonFastAPIServerCodegen
|
|
|
|
## Requirements.
|
|
|
|
Python >= 3.7
|
|
|
|
## Installation & Usage
|
|
|
|
To run the server, please execute the following from the root directory:
|
|
|
|
```bash
|
|
pip3 install -r requirements.txt
|
|
uvicorn main:app --host 0.0.0.0 --port 8080
|
|
```
|
|
|
|
and open your browser at `http://localhost:8080/docs/` to see the docs.
|
|
|
|
## Running with Docker
|
|
|
|
To run the server on a Docker container, please execute the following from the root directory:
|
|
|
|
```bash
|
|
docker-compose up --build
|
|
```
|
|
|
|
## Tests
|
|
|
|
To run the tests:
|
|
|
|
```bash
|
|
pip3 install pytest
|
|
PYTHONPATH=src pytest tests
|
|
```
|