forked from loafle/openapi-generator-original
046be5dba1
* Revert "v7.14.0 release (#21443)"
This reverts commit 5eb083e5ce.
* prepare v7.15.0 snapshot
* update samples
* update readme
* update doc
40 lines
863 B
Markdown
40 lines
863 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
|
|
- Generator version: 7.15.0-SNAPSHOT
|
|
- 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
|
|
PYTHONPATH=src uvicorn openapi_server.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
|
|
```
|