瀏覽文件

認識元源(Origo Source)

連線獨立內容與閱讀客戶端的開放協議,以及它與 ORSP 的關係。

本頁目錄

元源是什麼

Origo Source,中文名「元源」,讓獨立內容服務用同一套 HTTP 介面向閱讀客戶端提供書籍、文章與連載章節。 你保管自己的內容和儲存,閱讀器負責排版、閱讀互動與進度。元創等內容平臺也可以透過這個邊界分發作品。

看完整介紹:元源介紹頁。

Origo Source 與 ORSP

Origo Source 是 Origo X 的書源生態,ORSP 全稱為 Origo Source Protocol。 新書源使用以下規範命名:

項目 規範值
發現文件 protocol origo-source
預設發現路徑 /.well-known/origo-source.json
介面關係 發現文件 apiBaseUrl 下的 v1/...
協議請求頭 X-Origo-Source-Protocol
已釋出內容身份 原來的源、書籍與章節 ID

目前提供候選協議的規範與工具,下載包後設資料 標明對應版本、原始碼提交和檔案校驗值。 完整規範的唯一來源是 origo-source-protocol。

從核心閱讀開始

一個核心書源需要發現、搜尋、書籍詳情、章節目錄和正文。章節正文必須有 bookId、chapterId、title、contentType 和 content。 源 ID 保持全域性穩定,書籍和章節 ID 是源內身份;下載地址、頁碼與陣列位置不能替代內容身份。

使用者可以把發現地址加入支援 ORSP 的閱讀客戶端。舊 1.x 書源繼續使用原介面;新能力只有實現後才宣告。 協議定義某項能力,不代表每個書源或客戶端已經支援它。

讓職責保持清楚

內容適配發生在服務端,客戶端讀取結構化資料。自己的作者後臺、賬戶、積分與讀者同步保持獨立。 資料庫和物件儲存負責持久化,HTTP 層負責介面與快取,閱讀器負責展示和定位。這樣更換儲存或增加伺服器時,可以保持介面和內容身份。

起步可以使用檔案介面卡;內容規模增長後換成資料庫查詢和獨立檔案儲存。按實際負載增加快取與後臺任務,避免一開始引入過多服務。 只分發你有權提供的內容,原始上游憑據留在服務端。

繼續閱讀:搭建第一個書源、閱讀能力與更新。

HTTPS 與舊入口

HTTP 和 HTTPS 都支援。公開正式服務建議使用 HTTPS,包括發現文件、API、EPUB 與媒體檔案;用戶端驗證憑證和主機名稱,不靜默降級。HTTP/2、HTTP/3 由託管層協商,JSON 契約一致。本機開發可以使用 HTTP。

舊 /.well-known/open-reading-source.json 入口回傳舊 protocol: open-reading-source,保留 X-Open-Reading-Protocol 相容標頭,供已安裝的舊閱讀器使用。兩個入口的內容 ID 和 API 相同,不產生第二套內容。新用戶端接受兩種識別;現有用戶端是否支援新入口應以實際版本為準。

發現文件中的問題? 提出修正