class Analyzer::Specification::HttpFile

Overview

Parses .http / .rest request files — the format shared by the VS Code REST Client extension and the JetBrains HTTP Client.

Requests are separated by ###; the text after ### is a name/comment. A request is METHOD url [HTTP/version] (the method is optional and defaults to GET), followed by header lines, a blank line, and an optional body. {{var}} placeholders resolve from in-file @name = value definitions; anything left unresolved in the path is treated as a path parameter (:var) rather than literal text. JetBrains response-handler blocks (> {% ... %} / > script.js) are skipped.

Defined in:

analyzer/analyzers/specification/http_file.cr

Constant Summary

HTTP_METHODS = ALLOWED_HTTP_METHODS

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]