Code Monkey home page Code Monkey logo

fastapi_template's Introduction

fastapi_template

This is a FastAPI template. If you identify anything that requires optimization, kindly submit a pull request (PR) or open an issue. The example app is provided for reference purposes only, feel free to remove it once you start using the template.

How to config?

You can configure various environment settings in the configs.py file.

How to develop?

1. add tests

Following TDD, add tests in the unittests directory to validate the expected outcomes.

2. add api routes

  1. Add the models in models.__init__.py.
  2. Add the schemas for validating API data in example.schemas
  3. Add API routes in example.api
  4. Add exceptions in example.exceptions
  5. Add common business logic in example.services

How to start?

Start dependencies:

cd docker
docker-compose up -d

Run server:

cd src
poetry install
python manage.py migrate
python manage.py start

fastapi_template's People

Contributors

wangsiqian 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.