Base

GitHub

Base class for API-phase type builders.

API phase runs once per API at initialization time. Use it to register shared types used across all contracts.

Example

module Builder
  class API < Adapter::Builder::API::Base
    def build
      enum(:status, values: %w[active inactive])
      object(:error) do |object|
        object.string(:message)
      end
    end
  end
end

Instance Methods

#build

#build

GitHub

Builds API-level types.

Override this method to register shared types.

Returns

void

---

#enum

#enum(name, values:, **options, &block)

GitHub

See also

• API::Base#enum

---

#enum?

#enum?(name)

GitHub

See also

• API::Base#enum?

---

#object

#object(name, **options, &block)

GitHub

See also

• API::Base#object

---

#type?

#type?(name)

GitHub

See also

• API::Base#type?

---

#union

#union(name, **options, &block)

GitHub

See also

• API::Base#union

---