Flaskel은 REST API가있는 모든 유형의 플라스크 응용 프로그램에 대한 골격입니다.
flaskel init --helpflaskel.builder.AppBuilder 참조하십시오flaskel.tester 패키지로 테스트 지원flaskel.http 확장자는 AppBuilder를 통해 등록됩니다. flaskel.scripts.skeleton.ext 참조하십시오
제 3 자 확장 :
내 자신의 외부 확장 :
내부 확장 :
flaskel.ext.crypto.argon.Argon2 (Argon2)flaskel.ext.datetime.FlaskDateHelper (date_helper)flaskel.ext.ipban.FlaskIPBan (IPBAN)flaskel.ext.redis.FlaskRedis (redis)flaskel.ext.useragent.UserAgent (useragent)flaskel.ext.redis.FlaskRedis (redis)flaskel.ext.sendmail.ClientMail (client_mail)은 플라스크 메일을 확장합니다flaskel.ext.jobs.APJobs (스케줄러)는 Flask-Apscheduler를 확장합니다flaskel.ext.mongo.FlaskMongoDB (mongo)는 flask-pymongo를 확장합니다flaskel.ext.healthcheck.health.HealthCheck (HealthCheck), 기본 점검 : Glances, Mongo, Redis, Sqlalchemy, 시스템, 서비스 (HTTP API)래퍼 확장 :
flaskel.ext.caching.Cache 랩 플라스크 캐싱flaskel.ext.limit.RateLimit 랩 플라스크-limiterflaskel.ext.auth.DBTokenHandler , flaskel.ext.auth.redistokenhandler 랩 Flask-jwt추가 확장 :
flaskel.extra.mobile_support.MobileVersionCompatibility (mobile_version)flaskel.extra.stripe.PaymentHandler (Stripe) Flaskel은 가장 일반적인 API 또는 간단한 웹 컨트롤러에 유용한 뷰를 제공합니다.
flaskel.views.base.BaseViewflaskel.views.rpc.JSONRPCViewflaskel.views.template.RenderTemplateflaskel.views.template.RenderTemplateStringflaskel.views.base.Resourceflaskel.views.resource.CatalogResourceflaskel.views.resource.Restfulflaskel.views.resource.PatchApiViewflaskel.views.proxy.ProxyViewflaskel.views.proxy.ConfProxyViewflaskel.views.proxy.TransparentProxyViewflaskel.views.proxy.JsonRPCProxyflaskel.views.proxy.SchemaProxyViewflaskel.views.static.StaticFileViewflaskel.views.static.SPAViewflaskel.views.token.BaseTokenAuth추가 조회수 :
flaskel.extra.apidoc.ApiDocTemplateflaskel.extra.apidoc.ApiSpecTemplateflaskel.extra.media.ApiMediaflaskel.extra.media.GetMediaflaskel.extra.mobile_support.MobileReleaseViewFlaskel은 Sqlalchemy의 보조 구성 요소와 함께 제공됩니다.
flaskel schema --help class SQLAModel ( Model ):
def columns ( self ): ...
def get_one ( cls , raise_not_found = True , to_dict = True , * args , ** kwargs ): ...
def get_list ( cls , to_dict = True , restricted = False , order_by = None , page = None , page_size = None , max_per_page = None , * args , ** kwargs ): ...
def query_collection ( cls , params = None , * args , ** kwargs ): ...
def update ( self , attributes ): ... class ConfigProxy : ...
class ExtProxy : ... from flaskel import webargs
@ webargs . query (...)
...
@ webargs . payload (...)
...
@ webargs . query_paginate ()
...
webargs . paginate ()
webargs . Field . integer ()
webargs . Field . string ()
webargs . Field . decimal ()
webargs . Field . boolean ()
webargs . Field . positive ()
webargs . Field . not_negative ()
webargs . Field . not_positive ()
webargs . Field . negative ()
webargs . Field . isodate ()
webargs . Field . list_of ()
webargs . OptField . integer ()
webargs . OptField . string ()
webargs . OptField . decimal ()
webargs . OptField . boolean ()
webargs . OptField . positive ()
webargs . OptField . not_negative ()
webargs . OptField . not_positive ()
webargs . OptField . negative ()
webargs . OptField . isodate ()
webargs . OptField . list_of ()
webargs . ReqField . integer ()
webargs . ReqField . string ()
webargs . ReqField . decimal ()
webargs . ReqField . boolean ()
webargs . ReqField . positive ()
webargs . ReqField . not_negative ()
webargs . ReqField . not_positive ()
webargs . ReqField . negative ()
webargs . ReqField . isodate ()
webargs . ReqField . list_of () class PayloadValidator :
schemas = SCHEMAS
validator = JSONSchema
@ classmethod
def validate ( cls , schema , strict = True ): ...많은 소스에서 제공하는 많은 구성 키가 있으며 다른 소스의 동일한 키가 재정의됩니다. 소스 우선 순위 (낮은 ~ 높음) :
APP_CONFIG_FILEpython-decouple 통해 처리되므로 .env 또는 settings.ini 파일에 저장할 수 있습니다.ENV를 통한 구성 :
DEBUG : (기본값 : bool = true)TESTING : (기본값 : bool = debug)APP_NAME : (기본 = flaskel)APP_HOST : (기본값 = 127.0.0.1)APP_PORT : (기본값 : int = 5000)FLASK_APP : (default = app : app)SERVER_NAME : (default = app_host : app_port)FLASK_ENV : (기본 = 개발)LOCALE : (default = "en_en.utf8")JWT_ALGORITHM : (default = "hs512")JWT_ACCESS_TOKEN_EXPIRES : (기본값 : 1 일)JWT_REFRESH_TOKEN_EXPIRES : (기본값 : 14 일)TEMPLATES_AUTO_RELOAD : (기본값 : bool = debug)EXPLAIN_TEMPLATE_LOADING : (기본값 : bool = false)SEND_FILE_MAX_AGE_DEFAULT : (기본값 : 1 일)APIDOCS_ENABLED : (기본값 : bool = true)CONF_PATH : (기본 = flaskel/scripts/skeleton/res)SQLALCHEMY_DATABASE_URI : (default = sqlite : //db.sqlite)REDIS_URL : (default = mongodb : // localhost)REDIS_CONN_TIMEOUT : (기본값 : float = 0.05)MONGO_URI : (default = redis : //127.0.0.1 : 6379)MONGO_CONN_TIMEOUT_MS : (기본값 : int = 100)MONGO_SERVER_SELECTION_TIMEOUT_MS : (기본값 : int = 100)BASIC_AUTH_USERNAME : (default = admin)BASIC_AUTH_PASSWORD : (default = admin)ADMIN_EMAIL : (default = admin)ADMIN_PASSWORD : (default = admin)MAIL_DEBUG : (기본값 : bool = debug)MAIL_SERVER : (default = sendria.local)MAIL_PORT : (기본값 : int = 62000)MAIL_USERNAME : (기본값 : "")MAIL_PASSWORD : (기본값 : "")MAIL_USE_SSL : (기본값 : bool = false)MAIL_USE_TLS : (기본값 : bool = false)MAIL_DEFAULT_SENDER : (default = [email protected])MAIL_DEFAULT_RECEIVER : (default = [email protected])MAIL_RECIPIENT : (기본값 : [email protected])MAIL_TIMEOUT : (기본값 : int = 60)PREFERRED_URL_SCHEME : (default = http if flask_env = development else https)LOG_BUILDER : (기본 = 텍스트)LOG_APP_NAME : (default = app_name)LOG_LOGGER_NAME : (default = flask_env)LOG_REQ_SKIP_DUMP : (기본값 = 테스트되지 않음)LOG_RESP_SKIP_DUMP : (default = 테스트되지 않음)LOG_RESP_HEADERS : (default = [])LOG_REQ_HEADERS : (default = [])CF_STRICT_ACCESS : (default = false)VERSION_STORE_MAX : (기본 = 6)VERSION_CACHE_EXPIRE : (기본값 = 60)HTTP_PROTECT_BODY : (default = false)HTTP_DUMP_REQ_BODY : (default = false)HTTP_DUMP_RESP_BODY : (default = false)HTTP_SSL_VERIFY : (default = true)HTTP_TIMEOUT : (기본 = 10)USE_X_SENDFILE : (기본값 = 디버그하지 않음)ENABLE_ACCEL : (default = true)WSGI_WERKZEUG_LINT_ENABLED : (기본값 = 테스트)WSGI_WERKZEUG_PROFILER_ENABLED : (기본값 = 테스트)WSGI_WERKZEUG_PROFILER_FILE : (default = "profiler.txt")WSGI_WERKZEUG_PROFILER_RESTRICTION : *(기본값 : list = [0.1])SQLALCHEMY_ECHO : (기본값 = 테스트)JSONRPC_BATCH_MAX_REQUEST : (기본값 = 10)IPBAN_ENABLED : (default = true)IPBAN_KEY_PREFIX : (default = app_name)IPBAN_KEY_SEP : (default = /)IPBAN_BACKEND : (default = local)IPBAN_BACKEND_OPTS : (기본값 = {})IPBAN_COUNT : (기본 = 5)IPBAN_SECONDS : (기본 = 3600)IPBAN_NET_WHITELIST : (기본값 = 127.0.0.0/8)IPBAN_IP_WHITELIST : (기본값 = 127.0.0.1)IPBAN_STATUS_CODE : (기본값 = 403)IPBAN_CHECK_CODES : (기본값 = 404,405,501)RATELIMIT_ENABLED : (default = debug not debug)RATELIMIT_HEADERS_ENABLED : (default = true)RATELIMIT_IN_MEMORY_FALLBACK_ENABLED : (default = true)RATELIMIT_STORAGE_URL : (default = redis_url)RATELIMIT_KEY_PREFIX : (default = app_name)SCHEDULER_AUTO_START : (default = true)SCHEDULER_API_ENABLED : (default = false)CACHE_KEY_PREFIX : (default = app_name)CACHE_REDIS_URL : (기본 = redis_url)CACHE_DEFAULT_TIMEOUT : (기본값 = 1 시간)CACHE_DISABLED : (default = false)정적 응용 프로그램 구성 :
ERROR_PAGE : (default = "core/error.html")DATABASE_URL : (default = sqlalchemy_database_uri)SECRET_KEY_MIN_LENGTH : (기본값 : int = 256)PRETTY_DATE : (기본 = " %d %b %y %i : %m %p")DATE_ISO_FORMAT : (default = "%y-%m-%dt%h :%m :%s")JWT_DEFAULT_SCOPE : (default = none)JWT_DEFAULT_TOKEN_TYPE : (default = "bearer")JWT_TOKEN_LOCATION : (default = [ "헤더", "query_string"]))))HTTP_DUMP_BODY : (기본값 : [false, false])ACCEL_BUFFERING : (default = true)ACCEL_CHARSET : (default = "utf-8")ACCEL_LIMIT_RATE : (default = "off")RB_DEFAULT_ACCEPTABLE_MIMETYPES : (default = [ "application/json", "application/xml"]))))REQUEST_ID_HEADER : (default = "x-request-id")CACHE_TYPE : (default = "flask_caching.backends.redis")CACHE_OPTIONS : (dict)CORS_EXPOSE_HEADERS : (목록)RATELIMIT_STORAGE_OPTIONS : (dict)SCHEDULER_JOBSTORES : (dict)SCHEDULER_EXECUTORS : (DICT)SCHEDULER_JOB_DEFAULTS : (dict)LIMITER : (dict)FAIL : (default = "1/second")FAST : (기본 = "30/minute")MEDIUM : (default = "20/minute")SLOW : (default = "10/minute")BYPASS_KEY : (기본 = "X-Limiter-Bypass")BYPASS_VALUE : (Default = "Bypass-Rate-Limit") 추가 구성은 CONF_PATH 의 폴더의 파일을 통해 선택적으로로드됩니다.
APISPEC : (swagger.yaml)SCHEMAS : (schemas.yaml)SCHEDULER_JOBS : (scheduler.yaml)LOGGING : (log.yaml) 누락 된 경우, 기본 flaskel.utils.logger:LOGGING 사용됩니다내부 확장에 맞는 구성 :
flaskel.ext.crypto.argon.argon2
ARGON2_ENCODING : (기본 = UTF-8)ARGON2_TIME_COST : (기본값 = 3)ARGON2_HASH_LEN : (기본값 = 32)ARGON2_PARALLELISM : (기본 = 4)ARGON2_SALT_LEN : (기본값 = 16)ARGON2_MEMORY_COST : (기본값 = 65536) 64 MIBARGON2_PROFILE : (기본 = 낮음) 허용 LOW | Highflaskel.ext.healthcheck.health.healthcheck
HEALTHCHECK_ABOUT_LINK : (default = none)HEALTHCHECK_VIEW_NAME : (기본값 = HealthCheck)HEALTHCHECK_PATH : (Default = /HealthCheck)HEALTHCHECK_PARAM_KEY : (기본 = 수표)HEALTHCHECK_PARAM_SEP : (기본 = +)HEALTHCHECK_CONTENT_TYPE : (기본값 = 응용 프로그램/건강+json)flaskel.ext.dateTime.flaskDateHelper
DATE_HELPER_COUNTRY : (default = it)DATE_HELPER_PROV : (default = none)DATE_HELPER_STATE : (default = none)DATE_ISO_FORMAT : (default = "%y-%m-%dt%h :%m :%s")DATE_PRETTY : (default = " %d %b %y %i : %m %p")flaskel.ext.jobs.apjobs
SCHEDULER_AUTO_START : (default = false)SCHEDULER_PATCH_MULTITHREAD : (default = true)SCHEDULER_LOCK_FILE : (기본값 = .scheduler.lock)flaskel.ext.ipban.flaskipban
IPBAN_ENABLED : (default = true)IPBAN_KEY_PREFIX : (default = app_name)IPBAN_KEY_SEP : (default = /)IPBAN_BACKEND : (default = local)IPBAN_BACKEND_OPTS : (기본값 = {})IPBAN_COUNT : (기본 = 5)IPBAN_SECONDS : (기본 = 3600)IPBAN_NET_WHITELIST : (기본값 = 127.0.0.0/8)IPBAN_IP_WHITELIST : (기본값 = 127.0.0.1)IPBAN_STATUS_CODE : (기본값 = 403)IPBAN_CHECK_CODES : (기본값 = 404,405,501)flaskel.ext.caching.caching
CACHE_TYPE : (default = "flask_caching.backends.redis")CACHE_REDIS_URL : (기본 = redis_url)CACHE_DEFAULT_TIMEOUT : (default = seconds.hour)CACHE_KEY_PREFIX : (default = app_name)CACHE_OPTIONS : (DICT) REDIS 클라이언트 인스턴스로 전달했습니다flaskel.ext.redis.flaskredis
REDIS_URL : (default = redis : // localhost : 6379/0)REDIS_OPTS : (dict) 는 Redis Client 인스턴스로 전달되었습니다flaskel.ext.mongo.flaskmongodb
MONGO_URI : (default = mongodb : // localhost)MONGO_OPTS : (dict) mongodb 클라이언트 인스턴스로 전달되었습니다flaskel.ext.useragent.useragent
USER_AGENT_AUTO_PARSE : (default = false)flaskel.extra.stripe.paymenthandler (Stripe)
STRIPE_SECRET_KEY :STRIPE_PUBLIC_KEY :STRIPE_WEBHOOK_SECRET :STRIPE_DEBUG : (default = false)STRIPE_DEFAULT_CURRENCY : (기본값 = EUR)STRIPE_API_VERSION : (기본값 = 2020-08-27)flaskel.extra.mobile_support.mobileversioncompatibility (mobile_version)
VERSION_STORE_MAX : (기본 = 6)VERSION_CACHE_EXPIRE : (default = 3600)VERSION_CHECK_ENABLED : (default = true)VERSION_AGENT_HEADER : (default = x-agent)VERSION_API_HEADER : (default = x-api-version)VERSION_STORE_KEY : (default = x_upgrade_needed)VERSION_HEADER_KEY : (default = x-mobile-Version)VERSION_UPGRADE_HEADER : (default = x-upgrade-needed)VERSION_AGENTS : (default = (Android, iOS))VERSION_SKIP_STATUSES : (default = (금지, not_found, method_not_allowed, too_many_requests)))))))flaskel.extra.notification.notificationHandler
FCM_API_KEY : 사용하는 경우 필수flaskel.extra.media.service.mediaservice
MEDIA : (dict)ALLOWED_EXTENSIONS : (기본값 : [PNG, JPG])UPLOAD_FOLDER :EXTERNAL_URL :