A straightforward, starter HTTP REST API built on top of FastAPI. Quick to deploy, set up, and scale.
Out of the box, this starter includes lightweight implementations of the following features that are easy to extend and customize:
- REST API endpoints - a set of REST API endpoints using standard, spec-compliant methods like
GET&POST - Rate Limiting - automatic prevention of abuse of your API, at configurable rates based on customizable identifiers
- Caching - tiny persistence of API responses to reduce the load on your API and improve performance
- Dependency Injection - invert control and share common functionality across your API
- OpenAPI Documentation - automatically generated OpenAPI documentation for your API, that can be annotated and deployed alongside your code
- Type Hints - well-defined requests and responses with Pydantic models and type hints
- Environment Variables - configuration of your application using environment variables that can be set in a
.envfile
You can extend this template to include additional functionality like:
- Popular AI Libraries - add support for popular AI libraries like OpenAI with
poetry add openai, with the dependency included in yourpyproject.tomlfile new builds will automatically include it in your production environment - Database Support - add support for a database like PostgreSQL or MySQL, you can even spin one up alongside the rest of your Railway services
- Authentication - drop in whatever authentication/authorization scheme you please
The fastest way to get started is deploying to Railway which will spin up a new instance of this template connected to a GitHub repository. It will manage the networking of server code and the key-value Redis store for you, sharing connections between without any additional configuration.
Deploy on Railway in 1-click
Prerequisites:
- Clone the repository
git clone- Create a Poetry virtual environment
poetry env use 3.10Start a shell within the virtual environment
poetry shell- Install dependencies
poetry install- Run the application
First make sure to start a redis server with
redis-serverThen run the application with:
poetry run devYou should now be able to access the API at http://localhost:8000 on your machine.
You can deploy this application to Railway connected to a GitHub repository where every new Pull Request will generate a completely new, isolated preview environment. Merges to the main branch are automatically built and deployed with no additional config.
Railway provides a free tier that you can use to deploy this application to "kick the tires".
By default, FastAPI will generate an OpenAPI schema for your API. That schema is used to generate documentation for your API automatically. You can access the documentation at http://localhost:8000/docs. Your docs are made publicly available by default at /redoc and /docs when deploying your application as well.
To manage a local environment from your product environment, you can use the .env file included in this repo as an example for how to share configurations. Railway can also help you manage these variables and will provide some for the services they manage and some of their configurations.
Built on a modern stack with the following technologies:
- FastAPI - A modern, fast (high-performance), web framework for building APIs based on standard Python type hints.
- Python 3.10 - Supporting modern versions of Python to get the latest and greatest features.
- Poetry - A modern dependency management and packaging tool for Python.
- Redis - An open source, in-memory data structure store, used for caching and rate limiting.
- Visit the FastAPI docs for more information about building API's in general and structuring larger projects.
- Railway's docs provide more information about managing your application and exposing it to internet traffic.