class Analyzer::Specification::Strapi

Overview

Strapi turns every content type into REST routes under /api: a collection type gets the five-verb CRUD shape on its plural name, a single type gets read/update/delete on its singular name.

Custom routes declared in src/api/<name>/routes/*.{ts,js} are read separately and mounted under the same /api prefix.

Included Modules

Defined in:

analyzer/analyzers/specification/strapi.cr

Constant Summary

API_PREFIX = "/api"
ATTRIBUTE_TYPE_HINTS = {"string" => "string", "text" => "string", "richtext" => "string", "email" => "string", "password" => "string", "uid" => "string", "enumeration" => "string", "integer" => "int", "biginteger" => "int", "float" => "number", "decimal" => "number", "boolean" => "boolean", "date" => "datetime", "datetime" => "datetime", "time" => "datetime", "timestamp" => "datetime", "json" => "object"}
MAX_FILTER_PARAMS = 25
NON_SCALAR_TYPES = {"relation", "component", "dynamiczone", "media"}

Relations, components, dynamic zones and media are not scalar body fields - they take nested reference payloads rather than a value.

TAG_SOURCE = "strapi_analyzer"

Class Method Summary

Instance Method Summary

Instance methods inherited from module Analyzer::Specification::SchemaApiCommon

api_mount_join(prefix : String, path : String) : String api_mount_join, emit(sink : Array(Endpoint), url : String, method : String, params : Array(Param), details : Details, tag_name : String, tag_value : String, tag_source : String) : Endpoint emit, normalize_colon_path(path : String) : String normalize_colon_path, push_param_once(params : Array(Param), param : Param) : Nil push_param_once, type_hint(raw : String, table : Hash(String, String)) : String type_hint

Instance methods inherited from class Analyzer

analyze analyze, base_path : String base_path, base_paths : Array(String) base_paths, base_relative_path(path : String) : String base_relative_path, callees_needed? : Bool callees_needed?, content_matches?(content : String, markers : Regex) : Bool content_matches?, 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, tech : String tech, 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

Macros inherited from class Analyzer

analyzer_for(tech) analyzer_for

Instance methods inherited from module FileHelper

all_files : Array(String) all_files, get_files_by_basename(basename : String) : Array(String) get_files_by_basename, 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_files_by_relative_path(relative_path : String, root : String = "") : Array(String) get_files_by_relative_path, 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, walked_path(expanded : String) : String walked_path

Class Method Detail

def self.tech_name : String #

[View source]

Instance Method Detail

def analyze #

[View source]
def tech : String #

Instance-side view of the same declaration. The per-file rescues live on this base class, which has no way to name the analyzer that is running inside them, so a skipped file could not be attributed to a tech. Deriving it from analyzer_for keeps the name written exactly once.


[View source]