Introspection

Introspection exposes API structure as Ruby objects you can query — resources, actions, types, and params.

Resources, actions, types, enums, and error codes are exposed as explicit objects that reflect the API's structure and behavior.

This serves two purposes:

• Development – inspect what is exposed, including dynamically generated types
• Generation – exports and documentation read introspection directly

Each introspection object has type-checking methods and navigation accessors.

Facade Objects

Introspection returns typed objects:

api = Apiwork::API.introspect('/api/v1')

action = api.resources[:invoices].actions[:show]
body = action.response.body
body.shape.keys  # => [:invoice, :meta]

Predicates for type-checking:

status = api.types[:invoice].shape[:status]
status.enum?     # => true
status.enum      # => ["draft", "sent", "due", "paid"]
status.optional? # => false

Accessors provide navigation:

# Array element type
array_param.of  # => Param for element type

# Object fields
object_param.shape  # => Hash{Symbol => Param}

# Union variants
union_param.variants  # => Array<Param>

Hierarchy

API
├── info
│   ├── title, version, description
│   ├── contact
│   ├── license
│   └── servers
├── resources
│   ├── identifier, path
│   ├── actions
│   │   ├── method, path, raises
│   │   ├── request
│   │   │   ├── query
│   │   │   └── body
│   │   └── response
│   │       └── body
│   └── resources (nested)
├── types
├── enums
├── error_codes
└── raises

During Development

Adapters derive types from representations at runtime. Introspection makes these generated shapes visible.

Call .to_h on any introspection object to get a hash representation:

api.to_h
# => { path: "/api/v1", resources: {...}, types: {...} }

action.request.to_h
# => { query: {...}, body: {...} }

Usage

• API Introspection - entry point for full API
• Contract Introspection - entry point for single contract

See the reference documentation for complete method details.