API

GitHub

Facade for introspected API data.

Entry point for accessing all API data. Access resources via #resources, types via #types, enums via #enums.

Example

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

api.info.title # => "Mon API"
api.types[:address].description # => "Type d'adresse"
api.enums[:status].values # => ["draft", "published"]

api.resources.each_value do |resource|
  resource.actions.each_value do |action|
    # ...
  end
end

Modules

• Info
• Resource

Instance Methods

#base_path

#base_path

GitHub

The base path for this API.

Returns

String, nil

---

#enums

#enums

GitHub

The enums for this API.

Returns

Hash{Symbol => Enum}

---

#error_codes

#error_codes

GitHub

The error codes for this API.

Returns

Hash{Symbol => ErrorCode}

---

#info

#info

GitHub

The info for this API.

Returns

API::Info, nil

---

#resources

#resources

GitHub

The resources for this API.

Returns

Hash{Symbol => API::Resource}

---

#to_h

#to_h

GitHub

Converts this API to a hash.

Returns

Hash

---

#types

#types

GitHub

The types for this API.

Returns

Hash{Symbol => Type}

---