Protocols

The following protocols are available globally.

  • A protocol that defines the requirements for API authentication mechanisms.

    Conforming types must provide a set of headers for authentication and a method to generate authentication headers for API requests, supporting both client and user authentication via JWT tokens.

    See more

    Declaration

    Swift

    public protocol ApiAuthenticationInterface
  • A protocol that defines the requirements for building and manipulating API endpoint URLs.

    Conforming types must provide methods for adding versions, controllers, paths, and query parameters to endpoints, as well as building the final URL string. This protocol supports both string and enumerator-based inputs for flexibility and readability.

    See more

    Declaration

    Swift

    public protocol EndpointInterface
  • A protocol that defines a type that can be represented as a string.

    Declaration

    Swift

    public protocol StringRepresentable : RawRepresentable where Self.RawValue == String