fastapi-nano — Flask 目录站模板

SHA-256: 2197ab53c06d36d077ebb179404b6633cd954a661296b3be40d035699979e55d

2026-10-01T02:42:39.386Z

<div align="center">

![logo](https://user-images.githubusercontent.com/30027932/134270064-baecfbec-b3e7-4cb7-a07e-c11a58526260.png)

[![Mentioned in Awesome <INSERT LIST NAME>](https://awesome.re/mentioned-badge-flat.svg)](https://github.com/mjhea0/awesome-fastapi#boilerplate)
[![License](https://img.shields.io/github/license/rednafi/fastapi-nano?style=flat-square)](https://github.com/rednafi/fastapi-nano/blob/master/LICENSE)

</div>

## Description

This is a simple [FastAPI][fastapi] template that follows Flask's [blueprint][blueprint]
directory structure.

## Features

-   Uses [FastAPI][fastapi] to build the HTTP API endpoints.

-   Served with the [FastAPI CLI][fastapi_cli] using `fastapi dev` locally and
    `fastapi run` in the container, both running [Uvicorn][uvicorn] under the hood.

-   Simple reverse-proxying with [Caddy][caddy].

-   OAuth2 authentication with [Argon2][argon2] password hashing via [pwdlib][pwdlib]
    and Bearer JWT tokens via [PyJWT][pyjwt].

-   [CORS (Cross Origin Resource Sharing)][cors] enabled.

-   Flask inspired divisional directory structure, suitable for small to medium backend
    development.

-   Uses [FastAPI standard dependencies][fastapi_standard] and [uv][uv] for dependency
    management.

-   Uses [Pydantic Settings][pydantic_settings] for typed environment configuration.

-   Supports Python 3.14 and 3.13.

-   Dockerized with multi-stage Dockerfiles based on **python:3.14-slim** by default.
    Dockerfiles for Python 3.14 and 3.13 can be found in the `dockerfiles` directory.

## Quickstart

### Run in containers

-   Clone the repo and navigate to the root folder.

-   To run the app using Docker, make sure you've got [Docker][docker] installed on your
    system. From the project's root directory, run:

    ```sh
    make run-container
    ```

### Or, run locally

If you want to run the app locally, without using Docker, then:

-   Clone the repo and navigate to the root folder.

-   Install [uv][uv] for dependency management.

-   Start the app. Run:

    ```sh
    make run-local
    ```

    This will use [uv][uv] and `.python-version` to create or sync a `.venv` with
    Python 3.14 when needed, install dependencies, and start the FastAPI development
    server on `http://localhost:5002`.

### Explore the endpoints

-   To play around with the APIs, go to the following link on your browser:

    ```sh
    http://localhost:5002/docs
    ```

    This will take you to an UI like below:

    ![Screenshot from 2020-06-21 22-15-18][screenshot_1]

-   Press the `authorize` button on the right and add _username_ and _password_. The APIs
    use OAuth2 with Argon2 password hashing and Bearer JWT authentication. In this case,
    the username and password are `ubuntu` and `debian` respectively.

    ![Screenshot from 2020-06-21 22-18-25][screenshot_2]

    Clicking the `authorize` button will bring up a screen like this:

    ![Screenshot from 2020-06-21 22-18-59][screenshot_3]

-   Then select any of the `api_a` or `api_b` APIs, put an integer in the number box,
    and click the `Execute` button.

    ![Screenshot from 2020-06-21 22-31-19][screenshot_4]

-   Hitting the API should give a json response with random integers.

    ![Screenshot from 2020-06-21 22-32-28][screenshot_5]

-   Also, notice the `curl` section in the above screen shot. You can directly use the
    highlighted curl command in your terminal. Make sure you've got `jq` installed in your
    system.

    ```sh
    curl -X GET "http://localhost:5002/api_a/22" \
        -H "accept: application/json" \
        -H "Authorization: Bearer $(curl -X POST "http://localhost:5002/token" \
        -H "accept: application/x-www-form-urlencoded" \
        -d "username=ubuntu&password=debian" | jq -r ".access_token")"
    ```

    This should show a response like this. The random values will vary.

    ```json
    {
        "seed": 22,
        "random_first": 5,
        "random_second": 13
    }
    ```

### Housekeeping

-   Run tests with `make test` (uses [pytest][pytest]).
-   Lint with [ruff] and check types with [mypy] using `make lint`.
-   Update dependencies with `make dep-update`.
-   Stop containers with `make kill-container`.

## Directory structure

This shows the folder structure of the default template.

```txt
fastapi-nano
├── svc                           # primary service folder
│   ├── apis                      # this houses all the API packages
│   │   ├── api_a                 # api_a package
│   │   │   ├── __init__.py       # empty init file to make the api_a folder a package
│   │   │   ├── mainmod.py        # main module of api_a package
│   │   │   └── submod.py         # submodule of api_a package
│   │   └── api_b                 # api_b package
│   │       ├── __init__.py       # empty init file to make the api_b folder a package
│   │       ├── mainmod.py        # main module of api_b package
│   │       └── submod.py         # submodule of api_b package
│   ├── core                      # this is where the configs live
│   │   ├── auth.py               # authentication with OAuth2
│   │   ├── config.py             # typed environment settings
│   │   ├── logger.py             # logging configuration
│   │   └── __init__.py           # empty init file to make the core folder a package
│   ├── __init__.py               # configures logging when the svc package is imported
│   ├── main.py                   # main file where the FastAPI() class is called
│   ├── routes                    # this is where all the routes live
│   │   └── views.py              # file containing the endpoints for api_a and api_b
│   └── tests                     # test package
│       ├── __init__.py           # empty init file to make the tests folder a package
│       ├── test_apis.py          # integration testing the API responses
│       ├── test_logger.py        # unit testing logger configuration
│       └── test_functions.py     # unit testing the underlying functions
├── dockerfiles                   # Dockerfiles for supported Python versions
├── .env                          # env file containing app variables and Docker Python target
├── Caddyfile                     # simple reverse-proxy with caddy
├── docker-compose.yml            # docker-compose file
├── pyproject.toml                # pep-518 compliant config file
└── uv.lock                       # pinned app and dev dependencies
```

In the above structure, `api_a` and `api_b` are the main packages where the code of the APIs
live and they are exposed by the endpoints defined in the `routes` folder. Here, `api_a` and
`api_b` have identical logic. These are dummy APIs that take an integer as input and return
two random integers between zero and the input value. The purpose of including two identical
APIs in the template is to demonstrate how you can decouple the logics of multiple APIs and
then assemble their endpoints in the routes directory. The following snippets show the logic
behind the dummy APIs.

This is a dummy submodule that houses a function called `rand_gen` which generates a
dictionary of random integers.

```python
# This is a dummy module.
# This gets called in mainmod.py.

from __future__ import annotations

import random


def rand_gen(num: int) -> dict[str, int]:
    num = int(num)
    d = {
        "seed": num,
        "random_first": random.randint(0, num),
        "random_second": random.randint(0, num),
    }
    return d
```

The `main_func` in the primary module calls the `rand_gen` function from the submodule.

```python
from __future__ import annotations

from .submod import rand_gen


def main_func(num: int) -> dict[str, int]:
    d = rand_gen(num)
    return d
```

The endpoint is exposed like this:

```python
router = APIRouter()
logger = logging.getLogger(__name__)
CurrentUser = Annotated[UserInDB, Depends(get_current_user)]


# endpoint for api_a (api_b looks similar)
@router.get("/api_a/{num}", tags=["api_a"])
async def view_a(
    num: int,
    _auth: CurrentUser,
) -> dict[str, int]:
    result = main_func_a(num)
    logger.info(f"API A: {result}")
    return result
```

So hitting the API with a random integer will give you a response like the following. The
random values will vary.

```json
{
  "seed": 22,
  "random_first": 5,
  "random_second": 20
}
```

## Further modifications

-   You can put your own API logic following the shape of `api_a` and `api_b` packages.
    You'll have to add additional directories like `api_a` or `api_b` if you need to expose
    more endpoints.

-   Then expose the API URLs in the `routes/views.py` file. You may choose to create
    multiple `views` files to organize your endpoint URLs.

-   This template uses OAuth2 based authentication and it's easy to change that. FastAPI
    docs has a comprehensive list of the available [authentication][fastapi_security]
    options and instructions on how to use them.

-   During prod deployment, you might need to fiddle with the reverse-proxy rules in the
    Caddyfile.

## Resources

-   [Flask divisional folder structure][blueprint]
-   [Deploying APIs built with FastAPI](https://fastapi.tiangolo.com/deployment/)
-   [Reverse proxying with Caddy](https://caddyserver.com/docs/caddyfile/directives/reverse_proxy)

[blueprint]: https://flask.palletsprojects.com/en/2.3.x/blueprints/
[caddy]: https://caddyserver.com/docs/
[cors]: https://fastapi.tiangolo.com/tutorial/cors/
[docker]: https://www.docker.com/
[fastapi]: https://fastapi.tiangolo.com/
[argon2]: https://argon2-cffi.readthedocs.io/
[fastapi_cli]: https://fastapi.tiangolo.com/fastapi-cli/
[fastapi_security]: https://fastapi.tiangolo.com/tutorial/security/oauth2-jwt/
[fastapi_standard]: https://fastapi.tiangolo.com/#standard-dependencies
[pydantic_settings]: https://fastapi.tiangolo.com/advanced/settings/
[pwdlib]: https://github.com/frankie567/pwdlib
[pyjwt]: https://pyjwt.readthedocs.io/
[pytest]: https://docs.pytest.org/en/stable/
[ruff]: https://astral.sh/ruff
[uvicorn]: https://uvicorn.org/
[uv]: https://docs.astral.sh/uv/
[screenshot_1]:
    https://user-images.githubusercontent.com/30027932/85229723-5b721880-b40d-11ea-8f03-de36c07a3ce5.png
[screenshot_2]:
    https://user-images.githubusercontent.com/30027932/85229725-5e6d0900-b40d-11ea-9c37-bbee546f84a8.png
[screenshot_3]:
    https://user-images.githubusercontent.com/30027932/85229729-6036cc80-b40d-11ea-877e-7421b927a849.png
[screenshot_4]:
    https://user-images.githubusercontent.com/30027932/85229992-fcad9e80-b40e-11ea-850d-9ca86259d463.png
[screenshot_5]:
    https://user-images.githubusercontent.com/30027932/85230016-25359880-b40f-11ea-9196-c46fd72a760c.png

<div align="center">
✨ 🍰 ✨
</div>