Follow FastAPI official tutorial to learn how to use FastAPI with most of its features, step by step.
Follow the instructions to get the project up and running for local development and testing purposes.
- Install python 3: https://www.python.org/downloads/
- Create and activated a virtual environment where we can install all packages needed:
python3 -m venv ./venv/ source venv/bin/activate
- Configure the IDE Interpreter to use the python3 from the virtual environment
- Install project packages
make install
- Run command:
make run
- Open browser at http://127.0.0.1:8000
- Check the automatic Swagger API documentation at http://127.0.0.1:8000/docs
- Check the alternative automatic ReDoc documentation at http://127.0.0.1:8000/redoc
- Check the raw OpenAPI JSON schema automatically generated by FastAPI at http://127.0.0.1:8000/openapi.json
This project is licensed under the terms of the MIT License. Please see LICENSE for details.