class Analyzer::Specification::OpenRpc

Overview

OpenRPC 1.x analyzer.

JSON-RPC exposes a single HTTP path and selects the operation via the "method" field in the request body, so methods[] cannot map onto distinct URLs on its own. We emit one endpoint per RPC method, disambiguated by a URL fragment:

POST /rpc#eth_getBalance

This mirrors GraphqlSdlParser's /graphql#Query.user convention. The fragment is load-bearing: the optimizer dedupes on (method, url, scope), so without it every RPC method would collapse into one merged endpoint.

Each endpoint also carries a jsonrpc_<method> body param whose value is a ready-to-send JSON-RPC 2.0 request envelope, the same way the GraphQL analyzers attach a graphql_<operation>_<field> document param.

Defined in:

analyzer/analyzers/specification/openrpc.cr

Constant Summary

DEFAULT_RPC_PATH = "/"

Fallback when the document declares no usable server URL. JSON-RPC has no canonical path the way GraphQL has /graphql, so stay at the root rather than inventing one.

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?, http_header_name(name : String) : String | Nil http_header_name, line_number_for_index(content : String, char_index : Int32) : Int32 line_number_for_index, 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, unique_params(params : Array(Param)) : Array(Param) unique_params, url : String url, web_root_path(path : String, markers : Array(String)) : String web_root_path

Constructor methods inherited from class Analyzer

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

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_extensions(extensions : Array(String)) : Array(String) get_files_by_extensions, 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]