discogs-service/Sources/DiscogsService/Catalogs/DiscogsService.docc/Library.md

DiscogsService

A Swift client library for the Discogs API, built on top of Swift OpenAPI.

Overview

This library provides a type-safe client for interacting with the Discogs API, including endpoints for the database, user identity, user collections, wantlists, lists, and the marketplace. It supports multiple authentication methods and transports credentials via headers or query parameters.

Installation

To use this library, then add it as a dependency in the Package.swift file of your project:

    let package = Package(
        // name, platforms, products, etc.
        dependencies: [
            .package(url: "https://github.com/rock-n-code/discogs-service", from: "0.6.1"),
            // other dependencies
        ],
        targets: [
            .target(
                name: "SomeTarget",
                dependencies: [
                    .product(name: "DiscogsService", package: "discogs-service"),
                ]
            )
            // other targets
        ]
    )

It is also possible to use this library with your app in Xcode, then add it as a dependency in your Xcode project.

important: Swift 5.10 or higher is required in order to compile this library.

Topics

Clients

• Client

Servers

• LiveService

Authentication

• AuthMiddleware
• AuthMethod
• AuthTransport

User Agent

• UserAgentMiddleware
• Product

Types

• Components
• Operations
• Servers

Errors

• InputValidationError

Protocols

• APIProtocol