Protocols

Requests that the Service sends to the HTTPAdapter. This is actually just wraps the Request struct, erasing the Path type so the adapter doesn’t have to deal with it.

See more

public protocol AdapterRequest

The adapter for making HTTP requests. This may be implemented as an extension to a HTTP client or a custom type that implements this protocol.

It’s entirely async, with all methods receiving a callback. The adapter communicates success or failure to the callback using the HTTPAdapterResult enum, which encodes success and failure.

All the implementation details around encoding values and generating requests is left to the adapter and underlying client.

For example, the here are some of the adapter’s responsibility:

• Authentication
• Content negotiation
• Caching

See more

public protocol HTTPAdapter

Defines the base requirements for types that interact with Yopuy.

Note: This protocol should not be used directly, instead use the RootResource, ChildResource, SingularRootResource or SingularChildResource protocols.

See more

public protocol Resource

Defines a resource which is identifiable. That is, it has an id property and instances can be retrieved from the remote API by ID. This also implies that the resource is listable. So it includes the requirement for the parse(collection:) function.

Note: Do not use this protocol directly. You should instead conform your resources to RootResource or ChildResource

See more

public protocol IdentifiableResource: Resource

Defines a resource that exists at the root of the remote API.

public protocol RootResource: Resource, IdentifiableResource

Defines a resource that is a child of another.

Note: This protocol should not be used directly, instead use the ChildResource and SingularChildResource protocols.

public protocol NestedResource: Resource

Defines a resource that is related to a parent resource, which may be a RootResource or another ChildResource. This is done via the associatedtype Parent declaration. This is used as a constraint in order to direct the type-safe construction of paths which are used for requests.

public protocol ChildResource: NestedResource, IdentifiableResource

Defines a resource which exists at the root of the remote API and which has only one instance. Rather than being addressed by an ID, it is addressed by a constant path.

public protocol SingularRootResource: Resource

Defines a resource that is related to a parent resource, which may be a RootResource or another ChildResource and has only one instance. Rather than being addressed by an ID, it is addressed by a constant path.

The relationship to the parent is done via the associatedtype Parent declaration. This is used as a constraint in order to direct the type-safe construction of paths which are used for requests.

public protocol SingularChildResource: NestedResource

Flags a resource as being listable i.e. it has a collection. This protocol does nothing by itself, but has constrained extensions for types implementing RootResource and ChildResource.

See more

public protocol IsListable: Resource

Flags a resource as being showable i.e. a single resource can be requested. This protocol does nothing by itself, but has constrained extensions for types implementing RootResource and ChildResource.

See more

public protocol IsShowable: Resource

Flags a resource as being deletable. This protocol does nothing by itself, but has constrained extensions for types implementing RootResource and ChildResource.

See more

public protocol IsDeletable: Resource

Flags a resource as being creatable. This protocol does nothing by itself, but has constrained extensions for types implementing RootResource and ChildResource.

See more

public protocol IsCreatable

Flags a resource as being replacable i.e. supports PUT. This protocol does nothing by itself, but has constrained extensions for types implementing RootResource and ChildResource.

See more

public protocol IsReplaceable

Flags a resource as being patchable i.e. supports PATCH. This protocol does nothing by itself, but has constrained extensions for types implementing RootResource and ChildResource.

See more

public protocol IsPatchable

A convenience protocol which allows a resource to opt into all of the Is* protocols. It will add:

• IsListable
• IsCreatable
• IsShowable
• IsReplaceable
• IsPatchable
• IsDeletable

public protocol IsRESTFul: IsListable, IsCreatable, IsShowable, IsReplaceable, IsPatchable, IsDeletable