Boilerplate for restful API with tiangolo/fastapi

• [Endpoints] Auth, Sign up, Withdrawal, ... routes included (In Progress)
• [Router] Support class based Route
• [Config] .toml based config system, support environments
• [Authorize] Support custom OAuth2 authorization (Kakao)
• [Model] User and User related(meta, profile, ...) models
• [Depend] JWT(Json Web Token) based authorize, support cookie
• [Depend] User specific id with UUID
• [Depend] Logger with UUID
• [Integrate] Integrate with Sentry, Logstash
• [Comfy Query] Using Query, Easily
• And support all features of fastapi

• [Auth] POST /oauth - Using OAuth for Authentication
• [Auth] POST /token/refresh - Token Refresh
• [Auth] POST /logout - Logout
• [User] POST /users/ - Register
• [User] Get /users/me - Get user information (me)

Remove .example extension, change env on filename & content from .secrets.<env>.toml.example and setting.<env>.toml.example

 $ alembic upgrade head

 $ uvicorn app:app # or ./scripts/run 

 $ mysql -u root <test_database> < tests/testdata.sql

 $ pytest # or ./scripts/test

seed's Router is inherit fastapi.APIRouter, So you can use all the methods in APIRouter

from fastapi.responses import ORJSONResponse

from seed.router import Router, Route

router = Router(
  endpoint_options
)

@router.Route(
  '/{item_id}',
  endpoint_options={
    'response_class': ORJSONResponse
  }  # You can set default endpoint options
)  # This decorator add route into router
class Item(Route):
  _endpoint_options: Dict[str, Any] = {
    'status_code': 404
  }
  # Also you can setting default endpoint options in here
  # Option Priority : on Router -> on Route -> on Endpoint

  def get(item_id: int) -> Any:
    return f'item_id = {item_id}', 200  # You can set status code like this

  @Route.option(dependencies=[])  # Set FastAPI endpoints argument, More infos on below example
  def post(item_id: int) -> Any:
    return ORJSONResponse(f'item_id = {item_id}', status_code=201)  # Also, you can use FastAPI Response Class

  @Route.option(default_status_code=403)  # Or setting on option
  def post(item_id: int) -> Any:
    return '403 Forbidden'

router.Route('/foo/{item_id}')(Item)  # Or you can add route like this
router += '/bar/{item_id}', Item  # Or this
router.add('/daz/{item_id}')  # Or this

other_router = Router()

router.join(other_router, prefix='/foobar')  # You can include router like this
router.join(
  other_router,
  prefix='/barbaz',
  tags=['other_router'],
  responses={418: {"description": "I'm a teapot"}}
)  # Also, Support fastapi options!

arguments : name, default_status_code(=status_code), dependencies, operation_id, response_class, route_class_override, callbacks

arguments : enable(=include_in_schema), tags, summary, description, response_description, responses, deprecated

arguments : response_model, response_model_include, response_model_exclude, response_model_by_alias, response_model_exclude_unset, response_model_exclude_defaults, response_model_exclude_none

from seed.depends.auth import Auth

@router.get('/auth_required')
def auth_required(auth: Auth(required=True) = Depends()) -> Any:
  return auth.user

@router.get('/auth_optional')
def auth_required(auth: Auth() = Depends()) -> Any:
  return auth.user

@router.get('/auth_refresh_token')
def auth_required(auth: Auth(token_type='refresh') = Depends()) -> Any:
  return auth.user

You can setting jwt expires time, algorithm on here, and secret key on here

User data property, after load token and user data

Get token data with JWTToken

Verify with redis stored data

from seed.depends.uuid import UUID

@router.get('/uuid')
def uuid(uuid: UUID = Depends()) -> Any:
  return uuid  # 01dbd65e-1b46-35aa-9928-51333fe20858

Get uuid with fastapi request

This depend include UUID depend, same usage with just logger

from seed.logger import logger as default_logger
from seed.depends.context_logger import ContextLogger


@router.get('/logger_with_uuid')
def logger_with_uuid(context_logger: ContextLogger = Depends()) -> Any:
  default_logger.info('not show uuid!')  # not show uuid on stdout log
  context_logger.info('show uuid!')  # show uuid on stdout log
  return None

from seed.depends.redis import Redis

@router.get('/uuid')
def uuid(redis: Redis() = Depends()) -> Any:
  with redis() as r:
    print(r.get('test'))

from seed.models import Base, ModelMixin

class Model(Base, ModelMixin):
  ...

class Enum(enum.Enum):
  one = 'one'
  two = 'two'

Model.q()\
  .filter(
    Model.field == 'field',
    [Model.field2 == 'field2', Model.field2 == 'field3']
  )\
  .paging(page=0, limit=30)\
  .enum_order_by(UserModel.username, [Enum.one, Enum.two], 'desc')\
  .all()

1 depth is and operation, 2depth is or operation

[<env>.oauth.<provider>]
  handler = 'seed.oauth.<provider>.<provider>OAuthHandler'

Add provider's setting on <env>.oauth.<provider>

Make handler reference from Base Handler and Kakao Handler

Change or add setting <env>.integrate.sentry

[<env>.integrate.sentry]
enable = true
dsn = '<set_your_sentry_dsn>'

Change or add setting <env>.integrate.logstash

[default.integrate.logstash]
enable = true
host = '127.0.0.1'
port = 5959
database_path = 'logstash.db'

    [default.integrate.logstash.options]
    transport = 'logstash_async.transport.TcpTransport'
    ssl_enable = false
    ssl_verify = true
    keyfile = ''
    certfile = ''
    ca_certs = ''
    encoding = 'utf-8'

• API endpoints
• Add unittest testcases

You can see Here!

Copyright (c) 2020-2021 h4wldev@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.