Table of Contents - bluepine-0.1.4 Documentation
Pages
-
README
- Bluepine
- Table of Contents
- Quick Start
- Defining a schema
- Serializing schema
- Validating data
- Generating Open API (v3)
- Installation
- Attributes
- Creating Attribute
- Manually Creating Attribute
- Using
Attributes.create
- Using
Resolver
- Array Attribute
- Object Attribute
- Schema Attribute
- Attribute Options
- Custom Attribute
- Resolver
- Manually registering schema/endpoint
- Automatically registering schema/endpoint
- Serialization
- <a name=“serializer-example”></a> Example
- Serializing a simple type
- Serializing
Array
- Serializing
Object
- <a name=“serializer-options”></a> Options
- <a name=“serializer-options-method”></a>
:method
- <a name=“serializer-options-of”></a>
:of
- <a name=“serializer-options-private”></a>
:private
- Conditional Serialization
- <a name=“serializer-options-private”></a>
:if/:unless
- Custom Serializer
- Endpoint
- Defining Endpoint
- <a name=“endpoint-method”></a> Method
- <a name=“endpoint-params”></a> Params
- Defining default params
- Using no params
params: false
(default behaviour) - Using default params
params: true
- Using subset of default params's attributes
params: %i[...]
- Excluding some of default params's attributes
exclude: true
- Overriding default params with
params: Proc
- Re-using Params from Other Service
params: Symbol
- Endpoint Validation
- Validation
- Example
- Validating simple attribute
- Validating
Array
- Validating
Object
- Options
- <a name=“validator-options-required”></a>
:required
- <a name=“validator-options-match”></a>
:match
- <a name=“validator-options-min-max”></a>
:min/:max
- <a name=“validator-options-in”></a>
:in
- <a name=“validator-condition”></a> Conditional Validation
- <a name=“validator-options-if-unless”></a>
:if/:unless
- Custom Validator
- Custom Normalizer
- Validating
Endpoint
- Generating Open API (v3)
- Contributing
- License
Classes and Modules
- Bluepine
- Bluepine::API
- Bluepine::API::Generators
- Bluepine::API::Generators::Grpc
- Bluepine::API::Generators::Grpc::Generator
- Bluepine::API::Spec
- Bluepine::Assertions
- Bluepine::Attributes
- Bluepine::Attributes
- Bluepine::Attributes::ArrayAttribute
- Bluepine::Attributes::Attribute
- Bluepine::Attributes::BooleanAttribute
- Bluepine::Attributes::CurrencyAttribute
- Bluepine::Attributes::DateAttribute
- Bluepine::Attributes::FloatAttribute
- Bluepine::Attributes::IPAddressAttribute
- Bluepine::Attributes::IntegerAttribute
- Bluepine::Attributes::NumberAttribute
- Bluepine::Attributes::ObjectAttribute
- Bluepine::Attributes::SchemaAttribute
- Bluepine::Attributes::StringAttribute
- Bluepine::Attributes::TimeAttribute
- Bluepine::Attributes::URIAttribute
- Bluepine::Attributes::Visitor
- Bluepine::Endpoint
- Bluepine::Endpoint
- Bluepine::Endpoints
- Bluepine::Endpoints::Method
- Bluepine::Endpoints::Params
- Bluepine::Error
- Bluepine::Functions
- Bluepine::Functions::Result
- Bluepine::Generators
- Bluepine::Generators::Generator
- Bluepine::Generators::OpenAPI
- Bluepine::Generators::OpenAPI::Generator
- Bluepine::Generators::OpenAPI::PropertyGenerator
- Bluepine::Registry
- Bluepine::Resolvable
- Bluepine::Resolver
- Bluepine::Serializer
- Bluepine::Serializers
- Bluepine::Serializers::Serializable
- Bluepine::Support
- Bluepine::Validator
- Bluepine::Validators
- Bluepine::Validators::Normalizable
- Bluepine::Validators::Proxy
- Bluepine::Validators::Validatable
Methods
- ::create — Bluepine::Error
- ::create — Bluepine::Attributes
- ::create — Bluepine::Attributes
- ::generate — Bluepine::Generators::OpenAPI::PropertyGenerator
- ::included — Bluepine::Assertions
- ::key? — Bluepine::Attributes
- ::key? — Bluepine::Attributes
- ::model_name — Bluepine::Validators::Proxy
- ::new — Bluepine::Attributes::Attribute
- ::new — Bluepine::Attributes::ObjectAttribute
- ::new — Bluepine::Attributes::SchemaAttribute
- ::new — Bluepine::Endpoint
- ::new — Bluepine::Endpoints::Method
- ::new — Bluepine::Endpoints::Params
- ::new — Bluepine::Error
- ::new — Bluepine::Functions::Result
- ::new — Bluepine::Generators::Generator
- ::new — Bluepine::Generators::OpenAPI::Generator
- ::new — Bluepine::Registry
- ::new — Bluepine::Resolver
- ::new — Bluepine::Endpoint
- ::new — Bluepine::Serializer
- ::new — Bluepine::Validator
- ::new — Bluepine::Validators::Proxy
- ::normalize_name — Bluepine::Endpoint
- ::normalize_name — Bluepine::Endpoint
- ::register — Bluepine::Attributes
- ::register — Bluepine::Attributes
- ::visit — Bluepine::Generators::OpenAPI::PropertyGenerator
- #[] — Bluepine::Attributes::ObjectAttribute
- #[]= — Bluepine::Attributes::ObjectAttribute
- #assert — Bluepine::Assertions
- #assert_in — Bluepine::Assertions
- #assert_kind_of — Bluepine::Assertions
- #assert_kind_of_either — Bluepine::Assertions
- #assert_not — Bluepine::Assertions
- #assert_subset_of — Bluepine::Assertions
- #attributes — Bluepine::Attributes::Attribute
- #body? — Bluepine::Endpoints::Method
- #build — Bluepine::Endpoints::Params
- #build — Bluepine::Generators::OpenAPI::PropertyGenerator
- #build_params — Bluepine::Endpoints::Method
- #build_pattern — Bluepine::Generators::OpenAPI::PropertyGenerator
- #build_permitted_params — Bluepine::Endpoints::Params
- #build_ref — Bluepine::Generators::OpenAPI::PropertyGenerator
- #built? — Bluepine::Endpoints::Params
- #compose — Bluepine::Functions::Result
- #compose — Bluepine::Functions
- #compose_result — Bluepine::Functions
- #convert_id_params — Bluepine::Generators::OpenAPI::Generator
- #create — Bluepine::Registry
- #create_endpoint_registry — Bluepine::Resolver
- #create_method — Bluepine::Endpoint
- #create_method — Bluepine::Endpoint
- #create_params — Bluepine::Endpoints::Method
- #create_proxy — Bluepine::Validator
- #create_schema_registry — Bluepine::Resolver
- #create_validator — Bluepine::Endpoints::Method
- #curry — Bluepine::Functions
- #default — Bluepine::Attributes::Attribute
- #deprecated — Bluepine::Attributes::Attribute
- #description — Bluepine::Attributes::Attribute
- #endpoint — Bluepine::Resolver
- #endpoints — Bluepine::Resolver
- #ensure_loaded — Bluepine::Endpoint
- #ensure_loaded — Bluepine::Endpoint
- #errors — Bluepine::Endpoints::Method
- #execute_predicate — Bluepine::Serializer
- #extract_ids — Bluepine::Generators::OpenAPI::Generator
- #find_method — Bluepine::Attributes::Visitor
- #find_method! — Bluepine::Attributes::Visitor
- #format — Bluepine::Attributes::Attribute
- #format — Bluepine::Attributes::CurrencyAttribute
- #format — Bluepine::Attributes::DateAttribute
- #format — Bluepine::Attributes::FloatAttribute
- #format — Bluepine::Attributes::TimeAttribute
- #format — Bluepine::Attributes::URIAttribute
- #generate — Bluepine::Generators::Generator
- #generate — Bluepine::Generators::OpenAPI::Generator
- #generate_json_response — Bluepine::Generators::OpenAPI::Generator
- #generate_operation — Bluepine::Generators::OpenAPI::Generator
- #generate_operations — Bluepine::Generators::OpenAPI::Generator
- #generate_param — Bluepine::Generators::OpenAPI::Generator
- #generate_params — Bluepine::Generators::OpenAPI::Generator
- #generate_path_params — Bluepine::Generators::OpenAPI::Generator
- #generate_paths — Bluepine::Generators::OpenAPI::Generator
- #generate_query_params — Bluepine::Generators::OpenAPI::Generator
- #generate_request_params — Bluepine::Generators::OpenAPI::Generator
- #generate_response — Bluepine::Generators::OpenAPI::Generator
- #generate_responses — Bluepine::Generators::OpenAPI::Generator
- #generate_schema — Bluepine::Generators::OpenAPI::Generator
- #generate_schemas — Bluepine::Generators::OpenAPI::Generator
- #generate_server_urls — Bluepine::Generators::OpenAPI::Generator
- #get — Bluepine::Registry
- #get — Bluepine::Serializer
- #get — Bluepine::Validator
- #group — Bluepine::Attributes::ObjectAttribute
- #group_methods_by_path — Bluepine::Generators::OpenAPI::Generator
- #if — Bluepine::Attributes::Attribute
- #in — Bluepine::Attributes::Attribute
- #in — Bluepine::Attributes::BooleanAttribute
- #in — Bluepine::Attributes::StringAttribute
- #included — Bluepine::Support
- #is_array? — Bluepine::Validator
- #is_boolean? — Bluepine::Validator
- #is_float? — Bluepine::Validator
- #is_integer? — Bluepine::Validator
- #is_number? — Bluepine::Validator
- #is_object? — Bluepine::Validator
- #is_string? — Bluepine::Validator
- #is_valid? — Bluepine::Validator
- #iterate — Bluepine::Validator
- #key? — Bluepine::Registry
- #keys — Bluepine::Attributes::ObjectAttribute
- #keys — Bluepine::Registry
- #match — Bluepine::Attributes::Attribute
- #messages — Bluepine::Validators::Proxy
- #method — Bluepine::Attributes::Attribute
- #method — Bluepine::Endpoint
- #method — Bluepine::Endpoint
- #method_missing — Bluepine::Attributes::ObjectAttribute
- #method_missing — Bluepine::Validators::Proxy
- #methods — Bluepine::Endpoint
- #methods — Bluepine::Endpoint
- #native_type — Bluepine::Attributes::ArrayAttribute
- #native_type — Bluepine::Attributes::Attribute
- #native_type — Bluepine::Attributes::BooleanAttribute
- #native_type — Bluepine::Attributes::IntegerAttribute
- #native_type — Bluepine::Attributes::NumberAttribute
- #native_type — Bluepine::Attributes::ObjectAttribute
- #native_type — Bluepine::Attributes::StringAttribute
- #normalize — Bluepine::Registry
- #normalize — Bluepine::Validators::Normalizable
- #normalize_array — Bluepine::Assertions
- #normalize_attribute — Bluepine::Attributes::Visitor
- #normalize_attribute — Bluepine::Generators::OpenAPI::PropertyGenerator
- #normalize_attribute — Bluepine::Serializer
- #normalize_attribute — Bluepine::Validator
- #normalize_method — Bluepine::Attributes::Visitor
- #normalize_missing_value — Bluepine::Validators::Proxy
- #normalize_name — Bluepine::Endpoint
- #normalize_name — Bluepine::Endpoint
- #normalize_permitted_params — Bluepine::Endpoints::Params
- #normalize_schema_symbol — Bluepine::Attributes::Visitor
- #normalize_symbol — Bluepine::Attributes::Visitor
- #null — Bluepine::Attributes::Attribute
- #of — Bluepine::Attributes::Attribute
- #options — Bluepine::Attributes::Attribute
- #params — Bluepine::Endpoint
- #params — Bluepine::Endpoint
- #permit — Bluepine::Endpoints::Params
- #permit_params — Bluepine::Endpoints::Method
- #private — Bluepine::Attributes::Attribute
- #raises — Bluepine::Assertions
- #register — Bluepine::Registry
- #register — Bluepine::Resolver
- #register — Bluepine::Validators::Proxy
- #required — Bluepine::Attributes::Attribute
- #resolve — Bluepine::Resolver
- #resolve_methods — Bluepine::Attributes::Visitor
- #resolver — Bluepine::Resolvable
- #respond_to_missing? — Bluepine::Attributes::ObjectAttribute
- #respond_to_missing? — Bluepine::Validators::Proxy
- #respond_to_visitor? — Bluepine::Attributes::Visitor
- #result — Bluepine::Functions
- #rules — Bluepine::Validators::Validatable
- #run — Bluepine::Validator
- #schema — Bluepine::Resolver
- #schemas — Bluepine::Resolver
- #serializable? — Bluepine::Attributes::Attribute
- #serializable? — Bluepine::Serializer
- #serialize — Bluepine::Serializers::Serializable
- #spec — Bluepine::Attributes::Attribute
- #spec — Bluepine::Attributes::CurrencyAttribute
- #spec — Bluepine::Attributes::IPAddressAttribute
- #spec — Bluepine::Attributes::TimeAttribute
- #spec — Bluepine::Attributes::URIAttribute
- #spec_uri — Bluepine::Attributes::Attribute
- #spec_uri — Bluepine::Attributes::CurrencyAttribute
- #spec_uri — Bluepine::Attributes::IPAddressAttribute
- #spec_uri — Bluepine::Attributes::TimeAttribute
- #spec_uri — Bluepine::Attributes::URIAttribute
- #type — Bluepine::Attributes::Attribute
- #unless — Bluepine::Attributes::Attribute
- #url — Bluepine::Generators::OpenAPI::Generator
- #valid? — Bluepine::Endpoints::Method
- #valid? — Bluepine::Validators::Proxy
- #validate — Bluepine::Endpoints::Method
- #validate — Bluepine::Validator
- #validators — Bluepine::Validators::Validatable
- #value — Bluepine::Attributes::Attribute
- #visit — Bluepine::Attributes::Visitor
- #visit — Bluepine::Generators::OpenAPI::PropertyGenerator
- #visit — Bluepine::Validator
- #visit_array — Bluepine::Generators::OpenAPI::PropertyGenerator
- #visit_array — Bluepine::Serializer
- #visit_array — Bluepine::Validator
- #visit_attribute — Bluepine::Attributes::Visitor
- #visit_attribute — Bluepine::Generators::OpenAPI::PropertyGenerator
- #visit_attribute — Bluepine::Serializer
- #visit_attribute — Bluepine::Validator
- #visit_boolean — Bluepine::Validator
- #visit_float — Bluepine::Validator
- #visit_integer — Bluepine::Validator
- #visit_number — Bluepine::Validator
- #visit_object — Bluepine::Generators::OpenAPI::PropertyGenerator
- #visit_object — Bluepine::Serializer
- #visit_object — Bluepine::Validator
- #visit_object_handler — Bluepine::Serializer
- #visit_schema — Bluepine::Attributes::Visitor
- #visit_schema — Bluepine::Generators::OpenAPI::PropertyGenerator
- #visit_schema — Bluepine::Serializer
- #visit_schema — Bluepine::Validator
- #visit_string — Bluepine::Validator