class Analyzer::Specification::TypeSpec

Overview

TypeSpec (https://typespec.io) is Microsoft's OpenAPI-first IDL — .tsp files describe operations with @route / @get / @post / ... decorators that compose along namespace + interface scopes. This analyzer is a line/block parser (not a full TypeSpec compiler): it walks balanced braces, buffers decorators across newlines, and emits one endpoint per operation.

Defined in:

analyzer/analyzers/specification/typespec.cr

Constant Summary

HTTP_VERB_DECORATORS = {"get", "post", "put", "patch", "delete", "head", "options"}

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(channel : Channel(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, populate_channel_with_files(channel : Channel(String)) populate_channel_with_files, populate_channel_with_filtered_files(channel : Channel(String), extension : String)
populate_channel_with_filtered_files(channel : Channel(String), extensions : Array(String)) populate_channel_with_filtered_files

Instance Method Detail

def analyze #

[View source]
def push_endpoint(endpoint : Endpoint) #

[View source]