Module: Apiwork

Defined in:
lib/apiwork.rb,
lib/apiwork/api.rb,
lib/apiwork/error.rb,
lib/apiwork/issue.rb,
lib/apiwork/union.rb,
lib/apiwork/engine.rb,
lib/apiwork/export.rb,
lib/apiwork/object.rb,
lib/apiwork/adapter.rb,
lib/apiwork/element.rb,
lib/apiwork/request.rb,
lib/apiwork/version.rb,
lib/apiwork/api/base.rb,
lib/apiwork/api/info.rb,
lib/apiwork/registry.rb,
lib/apiwork/response.rb,
lib/apiwork/api/union.rb,
lib/apiwork/api/object.rb,
lib/apiwork/api/router.rb,
lib/apiwork/controller.rb,
lib/apiwork/error_code.rb,
lib/apiwork/export/zod.rb,
lib/apiwork/http_error.rb,
lib/apiwork/api/element.rb,
lib/apiwork/export/base.rb,
lib/apiwork/abstractable.rb,
lib/apiwork/adapter/base.rb,
lib/apiwork/api/registry.rb,
lib/apiwork/api/resource.rb,
lib/apiwork/configurable.rb,
lib/apiwork/domain_error.rb,
lib/apiwork/json_pointer.rb,
lib/apiwork/configuration.rb,
lib/apiwork/contract/base.rb,
lib/apiwork/export/sorbus.rb,
lib/apiwork/introspection.rb,
lib/apiwork/contract/union.rb,
lib/apiwork/contract_error.rb,
lib/apiwork/export/apiwork.rb,
lib/apiwork/api/info/server.rb,
lib/apiwork/contract/action.rb,
lib/apiwork/contract/object.rb,
lib/apiwork/export/open_api.rb,
lib/apiwork/export/pipeline.rb,
lib/apiwork/export/registry.rb,
lib/apiwork/adapter/registry.rb,
lib/apiwork/adapter/standard.rb,
lib/apiwork/api/info/contact.rb,
lib/apiwork/api/info/license.rb,
lib/apiwork/constraint_error.rb,
lib/apiwork/contract/element.rb,
lib/apiwork/api/enum_registry.rb,
lib/apiwork/api/type_registry.rb,
lib/apiwork/export/zod_mapper.rb,
lib/apiwork/introspection/api.rb,
lib/apiwork/export/type_script.rb,
lib/apiwork/introspection/dump.rb,
lib/apiwork/introspection/enum.rb,
lib/apiwork/introspection/type.rb,
lib/apiwork/api/resource/action.rb,
lib/apiwork/configuration_error.rb,
lib/apiwork/error_code/registry.rb,
lib/apiwork/introspection/param.rb,
lib/apiwork/reference_generator.rb,
lib/apiwork/representation/base.rb,
lib/apiwork/adapter/wrapper/base.rb,
lib/apiwork/configuration/option.rb,
lib/apiwork/export/sorbus_mapper.rb,
lib/apiwork/export/type_analysis.rb,
lib/apiwork/introspection/action.rb,
lib/apiwork/adapter/wrapper/shape.rb,
lib/apiwork/error_code/definition.rb,
lib/apiwork/export/apiwork_mapper.rb,
lib/apiwork/export/pipeline/writer.rb,
lib/apiwork/introspection/api/info.rb,
lib/apiwork/introspection/contract.rb,
lib/apiwork/introspection/dump/api.rb,
lib/apiwork/representation/element.rb,
lib/apiwork/adapter/capability/base.rb,
lib/apiwork/contract/action/request.rb,
lib/apiwork/contract/object/coercer.rb,
lib/apiwork/contract/request_parser.rb,
lib/apiwork/export/surface_resolver.rb,
lib/apiwork/introspection/dump/type.rb,
lib/apiwork/representation/root_key.rb,
lib/apiwork/adapter/builder/api/base.rb,
lib/apiwork/contract/action/response.rb,
lib/apiwork/contract/response_parser.rb,
lib/apiwork/introspection/dump/param.rb,
lib/apiwork/introspection/error_code.rb,
lib/apiwork/introspection/param/base.rb,
lib/apiwork/introspection/param/date.rb,
lib/apiwork/introspection/param/time.rb,
lib/apiwork/introspection/param/uuid.rb,
lib/apiwork/representation/attribute.rb,
lib/generators/apiwork/api_generator.rb,
lib/apiwork/adapter/capability/result.rb,
lib/apiwork/adapter/capability/runner.rb,
lib/apiwork/configuration/validatable.rb,
lib/apiwork/contract/object/validator.rb,
lib/apiwork/export/type_script_mapper.rb,
lib/apiwork/introspection/dump/action.rb,
lib/apiwork/introspection/param/array.rb,
lib/apiwork/introspection/param/union.rb,
lib/apiwork/representation/serializer.rb,
lib/apiwork/adapter/wrapper/error/base.rb,
lib/apiwork/introspection/api/resource.rb,
lib/apiwork/introspection/param/binary.rb,
lib/apiwork/introspection/param/number.rb,
lib/apiwork/introspection/param/object.rb,
lib/apiwork/introspection/param/record.rb,
lib/apiwork/introspection/param/string.rb,
lib/apiwork/representation/association.rb,
lib/apiwork/representation/inheritance.rb,
lib/apiwork/adapter/capability/api/base.rb,
lib/apiwork/adapter/wrapper/member/base.rb,
lib/apiwork/api/representation_registry.rb,
lib/apiwork/contract/object/transformer.rb,
lib/apiwork/introspection/dump/contract.rb,
lib/apiwork/introspection/dump/resource.rb,
lib/apiwork/introspection/param/boolean.rb,
lib/apiwork/introspection/param/decimal.rb,
lib/apiwork/introspection/param/integer.rb,
lib/apiwork/introspection/param/literal.rb,
lib/apiwork/introspection/param/unknown.rb,
lib/apiwork/representation/deserializer.rb,
lib/apiwork/adapter/capability/api/scope.rb,
lib/apiwork/api/enum_registry/definition.rb,
lib/apiwork/api/type_registry/definition.rb,
lib/apiwork/contract/object/deserializer.rb,
lib/apiwork/introspection/action/request.rb,
lib/generators/apiwork/install_generator.rb,
app/controllers/apiwork/errors_controller.rb,
lib/apiwork/adapter/builder/contract/base.rb,
lib/apiwork/adapter/serializer/error/base.rb,
lib/apiwork/adapter/wrapper/error/default.rb,
lib/apiwork/introspection/action/response.rb,
lib/apiwork/introspection/api/info/server.rb,
lib/apiwork/introspection/param/date_time.rb,
lib/apiwork/introspection/param/reference.rb,
lib/apiwork/representation/model_detector.rb,
lib/generators/apiwork/contract_generator.rb,
app/controllers/apiwork/exports_controller.rb,
lib/apiwork/adapter/wrapper/member/default.rb,
lib/apiwork/contract/request_parser/result.rb,
lib/apiwork/introspection/api/info/contact.rb,
lib/apiwork/introspection/api/info/license.rb,
lib/apiwork/adapter/wrapper/collection/base.rb,
lib/apiwork/contract/response_parser/result.rb,
lib/apiwork/adapter/capability/contract/base.rb,
lib/apiwork/adapter/serializer/error/default.rb,
lib/apiwork/adapter/serializer/resource/base.rb,
lib/apiwork/contract/object/validator/result.rb,
lib/apiwork/adapter/capability/contract/scope.rb,
lib/apiwork/adapter/capability/operation/base.rb,
lib/apiwork/adapter/standard/includes_resolver.rb,
lib/apiwork/adapter/wrapper/collection/default.rb,
lib/apiwork/adapter/serializer/resource/default.rb,
lib/apiwork/adapter/standard/capability/sorting.rb,
lib/apiwork/adapter/standard/capability/writing.rb,
lib/generators/apiwork/representation_generator.rb,
lib/apiwork/adapter/standard/capability/filtering.rb,
lib/apiwork/adapter/standard/capability/including.rb,
lib/apiwork/adapter/standard/capability/pagination.rb,
lib/apiwork/adapter/capability/operation/metadata_shape.rb,
lib/apiwork/adapter/capability/transformer/request/base.rb,
lib/apiwork/adapter/capability/transformer/response/base.rb,
lib/apiwork/adapter/serializer/error/default/api_builder.rb,
lib/apiwork/adapter/standard/capability/sorting/operation.rb,
lib/apiwork/adapter/standard/capability/writing/constants.rb,
lib/apiwork/adapter/standard/capability/writing/operation.rb,
lib/apiwork/adapter/standard/capability/filtering/constants.rb,
lib/apiwork/adapter/standard/capability/filtering/operation.rb,
lib/apiwork/adapter/standard/capability/including/operation.rb,
lib/apiwork/adapter/standard/capability/sorting/api_builder.rb,
lib/apiwork/adapter/standard/capability/pagination/operation.rb,
lib/apiwork/adapter/standard/capability/filtering/api_builder.rb,
lib/apiwork/adapter/standard/capability/pagination/api_builder.rb,
lib/apiwork/adapter/standard/capability/sorting/operation/sort.rb,
lib/apiwork/adapter/serializer/resource/default/contract_builder.rb,
lib/apiwork/adapter/standard/capability/sorting/contract_builder.rb,
lib/apiwork/adapter/standard/capability/writing/contract_builder.rb,
lib/apiwork/adapter/standard/capability/filtering/contract_builder.rb,
lib/apiwork/adapter/standard/capability/filtering/operation/filter.rb,
lib/apiwork/adapter/standard/capability/including/contract_builder.rb,
lib/apiwork/adapter/standard/capability/pagination/contract_builder.rb,
lib/apiwork/adapter/standard/capability/writing/request_transformer.rb,
lib/apiwork/adapter/standard/capability/filtering/request_transformer.rb,
lib/apiwork/adapter/standard/capability/pagination/operation/paginate.rb,
lib/apiwork/adapter/standard/capability/writing/operation/issue_mapper.rb,
lib/apiwork/adapter/standard/capability/filtering/operation/filter/builder.rb,
lib/apiwork/adapter/standard/capability/pagination/operation/paginate/cursor.rb,
lib/apiwork/adapter/standard/capability/pagination/operation/paginate/offset.rb,
lib/apiwork/adapter/standard/capability/filtering/operation/filter/operator_builder.rb

Defined Under Namespace

Modules: API, Abstractable, Adapter, Configurable, Contract, Controller, ErrorCode, Export, Generators, Introspection, Representation Classes: Configuration, ConfigurationError, ConstraintError, ContractError, DomainError, Element, Engine, Error, ErrorsController, ExportsController, HttpError, Issue, JSONPointer, Object, ReferenceGenerator, Registry, Request, Response, Union

Constant Summary collapse

UNSET =

Sentinel for an unset value. Distinguishes from explicit ‘nil`.

Object.new.freeze
VERSION = 
'0.7.0'

Class Method Summary collapse

Class Method Details

.call(env) ⇒ Object 



12
13
14
 
# File 'lib/apiwork.rb', line 12

def call(env)
  routes.call(env)
end

.prepare!(eager_load: false) ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/apiwork.rb', line 16

def prepare!(eager_load: false)
  API.clear!
  Adapter.clear!
  ErrorCode.clear!
  Export.clear!

  Adapter.register_defaults!
  ErrorCode.register_defaults!
  Export.register_defaults!

  load_api_definitions!
  eager_load_representations! if eager_load
end