class FastAPIAuthTagger

Defined in:

tagger/framework_taggers/python/fastapi_auth.cr

Constant Summary

AUTH_PARAM_PATTERNS = [{/:\s*User\s*=\s*Depends/, "FastAPI User dependency injection"}, {/:\s*TokenData\s*=\s*Depends/, "FastAPI TokenData dependency"}, {/:\s*HTTPAuthorizationCredentials\s*=\s*Security/, "FastAPI HTTP authorization"}]

Auth-related parameter type annotations

DEPENDS_AUTH_PATTERNS = [{/Depends\s*\(\s*get_current_user/, "FastAPI Depends(get_current_user)"}, {/Depends\s*\(\s*get_current_active_user/, "FastAPI Depends(get_current_active_user)"}, {/Depends\s*\(\s*oauth2_scheme/, "FastAPI OAuth2 dependency"}, {/Depends\s*\(\s*get_token/, "FastAPI token dependency"}, {/Depends\s*\(\s*verify_token/, "FastAPI token verification"}, {/Depends\s*\(\s*auth/, "FastAPI auth dependency"}, {/Depends\s*\(\s*require_auth/, "FastAPI require_auth dependency"}, {/Depends\s*\(\s*check_permission/, "FastAPI permission check"}, {/Depends\s*\(\s*RoleChecker/, "FastAPI role checker"}]

Depends() with auth-related callables

SECURITY_PATTERNS = [{/Security\s*\(\s*oauth2_scheme/, "FastAPI Security(oauth2_scheme)"}, {/Security\s*\(\s*api_key/, "FastAPI Security(api_key)"}, {/Security\s*\(\s*http_bearer/, "FastAPI Security(http_bearer)"}, {/Security\s*\(\s*http_basic/, "FastAPI Security(http_basic)"}]

Security() declarations

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from class FrameworkTagger

collect_files_by_extension(extension : String) : Array(String) collect_files_by_extension, read_file(path : String) : String | Nil read_file, read_source_context(endpoint : Endpoint) : Array(SourceContext) read_source_context, static_asset_route?(url : String) : Bool static_asset_route?

Constructor methods inherited from class FrameworkTagger

new(options : Hash(String, YAML::Any)) new

Class methods inherited from class FrameworkTagger

target_techs : Array(String) target_techs

Instance methods inherited from module FileHelper

all_files : Array(String) all_files, get_files_by_extension(extension : String) : Array(String) get_files_by_extension, get_files_by_prefix(prefix : String) : Array(String) get_files_by_prefix, get_files_by_prefix_and_extension(prefix : String, extension : String) : Array(String) get_files_by_prefix_and_extension, get_public_dir_files(base_path : String, folder : String) : Array(String) get_public_dir_files, get_public_files(base_path : String, anchors : Array(String) = ["shard.yml", "Gemfile"]) : Array(String) get_public_files

Instance methods inherited from class Tagger

name : String name, perform(endpoints : Array(Endpoint)) : Array(Endpoint) perform

Constructor methods inherited from class Tagger

new(options : Hash(String, YAML::Any)) new

Constructor Detail

def self.new(options : Hash(String, YAML::Any)) #

[View source]

Class Method Detail

def self.target_techs : Array(String) #

[View source]

Instance Method Detail

def perform(endpoints : Array(Endpoint)) : Array(Endpoint) #

[View source]