PlainApp
Tham chiếu API

Feeds (RSS)

Đăng ký feed RSS/Atom, lấy mục, và lưu bài viết vào ghi chú. Hỗ trợ nhập/xuất OPML.

Định nghĩa kiểu

bash
type Feed {
  id: ID!
  url: String!                # RSS/Atom URL
  name: String!               # display name (defaults to feed title)
  fetchContent: Boolean!      # when true, the server fetches the full article body
  updatedAt: String!
}

type FeedCount {
  feedId: ID!
  count: Int!                 # total entries
  unreadCount: Int!
}

type FeedEntry {
  id: ID!
  feedId: ID!
  title: String!
  description: String!        # short summary
  content: String!            # full article body (may be empty until fetched)
  url: String!                # canonical article URL
  publishedAt: String!        # ISO 8601
  read: Boolean!
  favorite: Boolean!
  tags: [Tag!]!
}

Thao tác

query

feeds

Liệt kê tất cả feed đã đăng ký.

bash
query GetFeeds {
  feeds { id url name fetchContent updatedAt }
}
query

feedsCount

Tổng số mục và số mục chưa đọc trên mỗi feed.

bash
query GetFeedsCount {
  feedsCount { feedId count unreadCount }
}
query

feedEntries

Tìm kiếm mục feed (tiêu đề + mô tả). Để query trống để liệt kê tất cả.

bash
query GetFeedEntries($offset: Int!, $limit: Int!, $query: String!) {
  feedEntries(offset: $offset, limit: $limit, query: $query) {
    id feedId title description content url publishedAt read favorite
    tags { id name }
  }
}
query

feedEntryCount

Đếm mục feed khớp với một query.

bash
query GetFeedEntryCount($query: String!) {
  feedEntryCount(query: $query)
}
query

feedEntry

Lấy một mục feed duy nhất theo ID.

bash
query GetFeedEntry($id: ID!) {
  feedEntry(id: $id) { id feedId title description content url publishedAt read favorite }
}
mutation

createFeed

Đăng ký một feed mới. Máy chủ lấy kênh RSS để điền tên, sau đó bắt đầu đồng bộ một lần.

bash
mutation CreateFeed($url: String!, $fetchContent: Boolean!) {
  createFeed(url: $url, fetchContent: $fetchContent) { id url name fetchContent updatedAt }
}
mutation

updateFeed

Cập nhật tên hiển thị của feed hoặc cờ fetchContent.

bash
mutation UpdateFeed($id: ID!, $name: String!, $fetchContent: Boolean!) {
  updateFeed(id: $id, name: $name, fetchContent: $fetchContent) { id url name fetchContent updatedAt }
}
mutation

deleteFeed

Hủy đăng ký feed và xóa tất cả mục của nó (và các quan hệ thẻ của chúng).

bash
mutation DeleteFeed($id: ID!) {
  deleteFeed(id: $id)
}
mutation

syncFeeds

Kích hoạt worker đồng bộ feed một lần. Truyền id để đồng bộ một feed duy nhất; truyền null hoặc rỗng để đồng bộ tất cả.

bash
mutation SyncFeeds($id: ID) {
  syncFeeds(id: $id)
}
mutation

syncFeedEntryContent

Fetch the full article body for a single feed entry. Returns the updated entry.

bash
mutation SyncFeedEntryContent($id: ID!) {
  syncFeedEntryContent(id: $id) { id content }
}
mutation

deleteFeedEntries

Xóa mục feed khớp với một query (và các quan hệ thẻ của chúng).

bash
mutation DeleteFeedEntries($query: String!) {
  deleteFeedEntries(query: $query)
}
mutation

importFeeds

Nhập một tài liệu OPML (dưới dạng chuỗi) vào cơ sở dữ liệu feed.

bash
mutation ImportFeeds($content: String!) {
  importFeeds(content: $content)
}
mutation

exportFeeds

Xuất tất cả feed đã đăng ký dưới dạng chuỗi OPML.

bash
mutation ExportFeeds {
  exportFeeds
}