https://github.com/zztkm/fastapi-template

https://github.com/zztkm/fastapi-template

Last synced: 10 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/zztkm/fastapi-template
• Owner: zztkm
• License: mit
• Created: 2024-05-04T05:34:47.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-05-04T05:35:35.000Z (8 months ago)
• Last Synced: 2024-12-20T23:29:48.742Z (14 days ago)
• Language: Dockerfile
• Size: 6.84 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# fastapi-template

## Requirements

- Docker

- Docker Compose

- Rye

## Links

- OpenAPI

    - Swagger UI

        - http://localhost:8000/docs#/

    - ReDoc

        - http://localhost:8000/redoc

## Commands

Run all services

```bash

make up

```

Run tests

```bash

make test

```

Down all services

```bash

make down

```

## あると便利なツール

- DBeaver

    - DB を直接確認するときに使う

- Postman

    - API 呼び出しを行うときに使う

    - ただし、FastAPI は Swagger があるので、そちらを使っても良い