Middleware¶
There are several middlewares available provided by Starlette directly.
Read more about them in theFastAPI docs for Middleware.
fastapi.middleware.cors.CORSMiddleware¶
CORSMiddleware(app,allow_origins=(),allow_methods=("GET",),allow_headers=(),allow_credentials=False,allow_origin_regex=None,allow_private_network=False,expose_headers=(),max_age=600,)Source code instarlette/middleware/cors.py
161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475 | |
appinstance-attribute¶
app=appallow_originsinstance-attribute¶
allow_origins=allow_originsallow_methodsinstance-attribute¶
allow_methods=allow_methodsallow_headersinstance-attribute¶
allow_headers=[(lower())forhinallow_headers]allow_all_originsinstance-attribute¶
allow_all_origins=allow_all_originsallow_all_headersinstance-attribute¶
allow_all_headers=allow_all_headerspreflight_explicit_allow_origininstance-attribute¶
preflight_explicit_allow_origin=(preflight_explicit_allow_origin)allow_origin_regexinstance-attribute¶
allow_origin_regex=compiled_allow_origin_regexallow_private_networkinstance-attribute¶
allow_private_network=allow_private_networksimple_headersinstance-attribute¶
simple_headers=simple_headerspreflight_headersinstance-attribute¶
preflight_headers=preflight_headersis_allowed_origin¶
is_allowed_origin(origin)Source code instarlette/middleware/cors.py
97 98 99100101102103104 | |
preflight_response¶
preflight_response(request_headers)Source code instarlette/middleware/cors.py
106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149 | |
simple_responseasync¶
simple_response(scope,receive,send,request_headers)Source code instarlette/middleware/cors.py
151152153 | |
sendasync¶
send(message,send,request_headers)Source code instarlette/middleware/cors.py
155156157158159160161162163164165166167168169170171172173174175176 | |
allow_explicit_originstaticmethod¶
allow_explicit_origin(headers,origin)Source code instarlette/middleware/cors.py
178179180181 | |
It can be imported fromfastapi:
fromfastapi.middleware.corsimportCORSMiddlewarefastapi.middleware.gzip.GZipMiddleware¶
GZipMiddleware(app,minimum_size=500,compresslevel=9)Source code instarlette/middleware/gzip.py
12131415 | |
It can be imported fromfastapi:
fromfastapi.middleware.gzipimportGZipMiddlewarefastapi.middleware.httpsredirect.HTTPSRedirectMiddleware¶
HTTPSRedirectMiddleware(app)Source code instarlette/middleware/httpsredirect.py
78 | |
appinstance-attribute¶
app=appIt can be imported fromfastapi:
fromfastapi.middleware.httpsredirectimportHTTPSRedirectMiddlewarefastapi.middleware.trustedhost.TrustedHostMiddleware¶
TrustedHostMiddleware(app,allowed_hosts=None,www_redirect=True)Source code instarlette/middleware/trustedhost.py
1314151617181920212223242526272829 | |
It can be imported fromfastapi:
fromfastapi.middleware.trustedhostimportTrustedHostMiddleware






