class Analyzer::Dart::Serverpod

Overview

Serverpod is an RPC-style backend framework. Server endpoints are Dart classes that extend Endpoint (or StreamingEndpoint); each public method takes a Session as its first parameter and is exposed to clients as a callable RPC. The class name's Endpoint suffix is dropped and the first character is lowercased to derive the endpoint name (OrderEndpoint → order).

Serverpod dispatches every call as a POST to /<endpointName> with the method name and arguments encoded in the body. We surface each method as POST /<endpointName>/<methodName> so individual RPCs are visible in the output, with the non-Session arguments reported as JSON body params.

Defined in:

analyzer/analyzers/dart/serverpod.cr

Constant Summary

HTTP_METHOD = "POST"
RESERVED_DART_NAMES = ["if", "else", "for", "while", "switch", "case", "return", "try", "catch", "finally", "throw", "new", "const", "final", "var", "late", "void", "await", "async", "assert"] of ::String
WEB_METHOD_MAP = {"get" => "GET", "post" => "POST", "put" => "PUT", "patch" => "PATCH", "delete" => "DELETE", "head" => "HEAD", "options" => "OPTIONS"}

Method.<verb> constants accepted by Route's methods: set.

Instance Method Summary

Instance methods inherited from class Analyzer

analyze analyze, base_path : String base_path, base_paths : Array(String) base_paths, callees_needed? : Bool callees_needed?, logger : NoirLogger logger, parallel_analyze(files : Array(String), &block : String -> Nil) parallel_analyze, read_file_content(path : String) : String read_file_content, result : Array(Endpoint) result, url : String url

Constructor methods inherited from class Analyzer

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

Macros inherited from class Analyzer

define_getter_methods(names) define_getter_methods

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 Method Detail

def analyze #

[View source]