FeedKit Documentation

When the feed format is unknown, use the universal Feed enum. It automatically detects whether the feed is RSS, Atom, or JSON before parsing and decoding. You can then use a switch statement to handle the specific resulting model.

// Read any type of feed
let feed = try await Feed(urlString: "https://surprise.me/feed")

// Use a switch to get the resulting feed model
switch feed {
case let .atom(feed): // An AtomFeed instance
case let .rss(feed): // An RSSFeed instance
case let .json(feed): // A JSONFeed instance
}

To add FeedKit to your Xcode project:

1. Open your project in Xcode.
2. Go to the File menu and select Add Package Dependencies…
3. Enter the Package URL: https://github.com/nmdias/FeedKit
4. Select Add Package.

To generate a JSON string, create an instance of JSONFeed, populate it, and call toJSONString(formatted:).

try feed.toJSONString(formatted: true)

To generate an XML string, create an instance of RSSFeed or AtomFeed, populate it with data, and call toXMLString(formatted:).

let feed = RSSFeed(
  channel: .init(
    title: "Breaking News",
    link: "http://www.breakingnews.com/",
    description: "Get the latest updates as they happen.",
    // ...
    items: [
      .init(
        title: "Breaking News: All Hearts are Joyful",
        link: "http://breakingnews.com/2025/01/09/joyful-hearts",
        description: "A heartwarming story of unity and celebration."
        // ...
      ),
    ]
  )
)

try feed.toXMLString(formatted: true)

To identify the type of a feed (RSS, Atom, or JSON) without the overhead of full parsing and decoding, use the FeedType initializer with raw Data. You can also check if the content is XML or JSON using the isXML and isJson properties.

let feedType = try FeedType(data: data)

// Detect feed type
switch feedType {
case .rss: // RSS feed detected
case .atom: // Atom feed detected
case .json: // JSON feed detected
}

// Or feed content type
if feedType.isXML {
  // XML feed detected
} else if feedType.isJson {
  // JSON feed detected
}

If you know the specific format of the feed (RSS, Atom, or JSON), use the corresponding dedicated type for more direct access to its properties.

try await RSSFeed(urlString: "https://developer.apple.com/news/rss/news.rss")

All feed types conform to FeedInitializable, providing several ways to load data. Available initializers include:

• init(urlString: String) async throws
• init(url: URL) async throws (handles both local and remote URLs)
• init(fileURL url: URL) throws (local file URLs)
• init(remoteURL url: URL) async throws (remote URLs)
• init(string: String) throws (XML or JSON strings)
• init(data: Data) throws (raw data)