Code Monkey home page Code Monkey logo

fastapi-example's Introduction

fastapi-example

An example of FastAPI basics

Codacy Badge Codacy Badge

Getting set up

Check the Makefile for useful macros

Using Poetry install dependencies

poetry install
poetry shell

Run migrations

make migrate

Structure

-- .github      : Github Actions defintions
-- alembic      : Database table definitions
-- app
---- api        : Endpoint defintions and routes
---- core       : Configuration management
---- crud       : Tools for performing CRUD ops on various models
---- db         : Boilerplate sqlalchemy set up
---- schemas    : Pydantic definitions for models and API requests/responses
---- tests      : Unit and BDD tests

Build the docker image

make docker-build

Start the docker image

make docker-run

The API will be available at http://localhost (port 80) Docs are at http://localhost/docs

Tests

Run unittests with coverage (in app/tests):

make test-cov

Or with pytest-watch to rerun tests every time a change is made:

make test-watch

Run Behave tests (in app/tests/features):

make bdd

Linting

You can check if your code is up to scratch:

make lint

Fix it automatically:

make format-imports

fastapi-example's People

Contributors

fergusdixon avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.