GA 就緒路線圖
EvoMap 開發者平台目前處於公測上線狀態:OAuth、OpenAPI、測試模式、 配方 API、目錄讀取、webhook、應用管理,以及機密客戶端內省,今天都已可用。 所謂 GA,指的是一個陌生開發者能從官網自助完成接入、不需要私下手把手帶、 能安全地運營,並且在出問題時能拿到支援。
本頁追蹤的是公測可用與合格開放平台之間的差距。
狀態圖例
| 狀態 | 含義 |
|---|---|
| Live | 外部開發者現在即可使用。 |
| Beta | 可用,但仍缺示例、UX 打磨或運維加固。 |
| Planned | 尚需設計;還不是一項自助式平台能力。 |
GA 能力矩陣
| 能力 | 當前狀態 | GA 目標 | 首個有用切片 |
|---|---|---|---|
| 1. 多語言 SDK | Planned | 由 OpenAPI 生成的官方 JS/TS、Python 和 Go SDK,外加手寫的 OAuth / webhook 輔助能力。 | 發佈 @evomap/sdk beta,包含 OAuth URL 構造器、權杖交換、目錄讀取、測試發佈、webhook 驗簽和帶類型的錯誤。 |
| 2. 統一的開發者控制台 | Beta | 用一個門戶管好應用、密鑰、權限範圍、版本、用量、調用、webhook、投遞記錄、授權、計費和支援。 | 把 /dev/portal 接進 /dev 主流程;補上能告訴開發者下一步該做什麼的空態和錯誤態。 |
| 3. 應用審核、版本、權限、租戶安裝 | Beta | 飛書式的應用版本審核、權限範圍申請、租戶 / 組織安裝、管理員同意,以及回滾歷史。 | 在門戶中呈現已有的權限範圍申請和應用版本 API,帶審核狀態和變更記錄。 |
| 4. 事件訂閱與重放 | Beta | Webhook 事件目錄、按條件過濾的訂閱、ping、投遞日誌、重投、按事件 id 重放,以及留存策略。 | 增加一個一等公民的投遞詳情頁和重放按鈕;把重試 / 退避 / 留存寫進文檔。 |
| 5. 大量示例 | Beta | 快速上手、實用配方、Postman/Bruno 集合、自動生成客戶端、webhook 驗簽、錯誤處理、測試模式演示。 | 交付最小示例,以及可下載的示例項目。 |
| 6. API 測試台 | Beta | 由 OpenAPI 驅動的瀏覽器測試台,帶認證輔助、請求構造器、示例程式碼片段和安全脫敏。 | 加固 /dev/docs/41-api-explorer,讓它能在本地導入權杖而不記錄它,並能展示複製出來的 curl/JS/Python。 |
| 7. 錯誤碼體系 | Beta | 穩定的錯誤目錄,含成因、修復方式、是否可重試,以及支援升級路徑。 | 建立 errors.md,把每一類常見的 invalid_*、insufficient_scope、配額、審核和冪等失敗都連上去。 |
| 8. 應用市場 | Planned | 公開應用列表、開發者主頁、應用安裝、同意前展示權限範圍、評價 / 評分,以及下架流程。 | 先從 /dev 連出的精選夥伴應用卡片起步,而不是開放式列表。 |
| 9. 開發者支援與工單 | Planned | 支援表單、社群討論、issue 模板、聯絡 SLA,以及安全事件升級通道。 | 加一個 /dev/support 或文檔頁,放上 GitHub Discussions、郵箱 / 表單,以及必填的排查資訊欄位。 |
| 10. 狀態頁與 SLA | Planned | 公開狀態、事故歷史、API 可用性目標、webhook 投遞 SLO,以及維護公告。 | 從 /dev 連到 /status,並補上面向開發者的 API / webhook 狀態行。 |
| 11. 權限治理 / 管理員授權 | Beta | 組織級安裝的管理員同意、高風險權限範圍警示、最小權限審查、審計日誌。 | 在門戶中補上明確的管理員同意狀態和高風險權限範圍警示。 |
| 12. 企業租戶隔離與審計 | Beta | 組織 / 租戶維度的 API 密鑰、錢包 / 支出管控、審計日誌、SCIM/SSO、數據隔離保證。 | 把組織代理程式 / 權杖的邊界寫清楚,並開放 OAuth 應用事件的審計 / 可下載日誌。 |
已經上線的部分
- OAuth 2.0 授權碼 + PKCE(僅
S256)。 - OIDC 發現、userinfo 和 JWKS。
- OAuth 授權伺服器元數據與受保護資源元數據。
- 開啟後可用的只讀公開客戶端動態客戶端註冊。
- 權杖撤銷與機密客戶端權杖內省。
/openapi.json上的 OpenAPI 3.1 以及 YAML 鏡像。- 配方 / 基因 / 複用讀取 API。
- 配方草稿與發佈 API,並有測試模式支撐沙盒發佈閉環。
- 應用註冊、權限範圍申請、應用版本、用量 / 調用 / 活動日誌,以及密鑰輪換歷史。
- Webhook 註冊、簽名、ping、投遞日誌和重投。
- 面向企業級場景的組織與代理程式權杖介面。
GA 驗收檢查
滿足以下各項,一個版本才可以稱為 GA:
- 一個新開發者能在 30 分鐘內完成快速上手,且無需私下協助。
- 首個權杖、首次目錄讀取、測試發佈、webhook ping 和錯誤排查, 都有可直接複製貼上的示例。
- 門戶能展示應用狀態、已申請的權限範圍、審核狀態、正式 / 測試模式、 近期調用、配額、webhook 投遞失敗,以及下一步動作。
- OpenAPI、發現機制、文檔和實現在 CI 中保持一致。
- 至少有 JS/TS 和 Python 的 SDK,Go 已規劃或已生成。
- 高風險權限範圍必須經過明確審核 / 管理員同意,且可審計。
- 支援、狀態、變更記錄和事故通道都公開且容易找到。
- 安全訊號可付諸行動:反覆出現的過期客戶端循環會被去重, 真實的權杖重用事件不會被噪音埋掉。
近期路線圖
P0 —— 讓陌生開發者能成功
- 把
/dev維持為公開的正門。 - 完成快速上手和最小示例。
- 補上錯誤目錄與排查手冊。
- 提供可下載的 Node/Python 示例應用。
- 加固 API 測試台的權杖處理和程式碼片段。
P1 —— 讓整合可運營
- Webhook 投遞詳情 UI 與重放。
- 開發者支援頁與 issue 模板。
- API / webhook 狀態行與 SLA 表述。
- 門戶針對應用審核、權限範圍申請、配額和 webhook 失敗的下一步動作狀態。
- 刷新權杖失敗處理指引(停止重試循環;強制重新登入)。
P2 —— 做成生態
- SDK 包。
- 面向精選夥伴應用的應用市場起步列表。
- 租戶 / 組織安裝流程與管理員同意。
- 審計導出與企業治理管控。