📖 項目簡介
Rubik Code 是一款信也科技自研的智能代碼分析與API文檔自動化生成平台。該系統能夠深度解析Java代碼庫，精準提取代碼結構、方法關聯、業務邏輯等核心信息，並藉助AI的自然語言處理能力，自動生成符合行業標準的規範化API接口文檔。其核心目標是為企業與開發團隊打造一個全面統一、標準規範的接口文檔管理中樞，解決傳統API文檔編寫效率低、更新不及時、格式不統一等痛點，充分發揮人機協作的優勢。
🏗️ 項目架構
系統核心架構分為兩大核心模塊：
- 代碼智能分析與CodeBase構建模塊；
- AI驅動的API文檔生成模塊。
✨ 核心功能
全維度代碼庫分析與CodeBase構建
平台支持從遠程代碼倉庫拉取代碼，並執行多維度、深層次的代碼解析，最終構建結構化的CodeBase知識庫，為後續文檔生成提供堅實的數據支撐。核心能力包括：
- 靈活的代碼獲取： 支持從GitLab等主流代碼倉庫克隆指定分支、指定Commit版本的代碼；
- AST語法樹深度解析： 對Java源代碼進行語法層面的全面解析，精準提取類定義、方法體、參數類型、返回值、註釋信息等結構化數據；
- MyBatis關聯分析： 專門針對MyBatis映射文件（XML）進行解析，提取SQL語句詳情，並建立SQL與Java方法的關聯映射關係，完整還原數據訪問層邏輯；
- ASM字節碼增強分析： 通過字節碼分析技術，挖掘代碼的深層關聯信息，包括類的繼承與實現關係、方法間的調用鏈路、字段的依賴傳遞等，彌補表層語法分析的不足；
- Maven模塊智能識別： 自動識別Maven項目的目錄結構與依賴關係，精準提取各應用模塊的邊界與職責，實現按模塊的精細化分析。
代碼關係建模
系統通過智能分析，將分散的代碼元素轉化為可追溯的關係網絡，並持久化存儲，為代碼理解和文檔生成提供全景視角。核心關聯關係包括：
- 類層級關係： 清晰呈現類的繼承鏈路與接口實現關係；
- 字段依賴關係： 追蹤類字段的定義、引用及傳遞依賴；
- 參數關聯關係： 解析方法參數的類型定義和關聯對象；
- 方法調用關係： 構建跨類、跨模塊的方法調用關係網絡。
精細化代碼打標體系
為實現代碼的精準分類與快速檢索，系統建立了多維度的代碼打標機制，從功能屬性和技術屬性兩個維度對代碼元素進行標準化標記，提升後續分析的精準度。
- Java文件打標功能維度： Controller（控制層）、Service（服務層）、Dao（數據訪問層）、XXL-JOB（定時任務入口）等；
- 類型維度： Interface（接口）、Enum（枚舉）、Annotation（註解）等；
- 函數方法打標功能維度： Sql（數據操作）、Api（接口服務）、JobExecutor（任務執行）等；
- 類型維度： Abstract（抽象方法）、Static（靜態方法）、Default（默認方法）等。
AI驅動的標準化API文檔生成
基於CodeBase中的結構化數據，平台通過AI大模型的語義理解與規範化表達能力，自動生成符合開發習慣的高質量API接口文檔，無需人工手動編寫，極大提升文檔生產效率。生成的文檔包含以下核心內容：
- 接口基礎信息： 完整呈現請求方法（GET/POST等）、請求路徑、接口名稱及核心功能描述，快速掌握接口用途；
- 入參詳細説明： 以標準化表格形式展示參數名稱、類型、是否必填、默認值及描述，支持嵌套對象、枚舉類型等複雜參數結構的清晰拆解；
- 出參規範説明： 詳細説明響應參數的結構、數據類型及業務含義，明確成功與異常響應的返回格式，降低對接成本；
- 接口實現邏輯： 按實際執行順序，清晰描述接口從請求接收、參數校驗、業務處理到結果返回的完整業務流程，幫助開發者理解底層邏輯；
- 可視化業務流程圖： 自動生成基於Mermaid語法的業務流程圖，直觀呈現接口的執行鏈路與分支邏輯，便於快速梳理業務脈絡；
- 實用代碼示例： 提供入參請求示例與出參響應示例，開發者可直接參考使用，提升接口調試效率。
📊 效果展示
接口文檔基本信息展示
清晰呈現接口核心信息，格式規範統一，關鍵信息一目瞭然。
可視化呈現接口執行流程，複雜邏輯直觀化，便於團隊協作與知識傳遞。
詳細的參數説明與完整的邏輯描述，結合實用的代碼示例，滿足開發對接與代碼理解需求。
未來展望
1. 智能化文檔維護與實時同步
未來將探索基於代碼變更的文檔自動化更新機制。通過與CI/CD流程深度集成，平台可監聽代碼倉庫的提交與合併請求，自動識別接口變更（如參數增減、路徑調整、邏輯修改），並觸發對應API文檔的智能修訂與版本管理，確保文檔與代碼實現始終保持實時同步，徹底告別“文檔滯後”時代。
2. 多語言支持與泛框架解析能力拓展
在持續深化Java生態支持的基礎上，計劃逐步擴展對Go、Python、TypeScript等主流編程語言的解析能力，並增加對Spring Cloud、gRPC、GraphQL等框架和協議的適配。旨在打造一個跨語言、跨框架的統一API文檔治理平台，滿足企業在多技術棧並行場景下的標準化管理需求。
3. 交互式文檔與開發者協作深化
進一步強化文檔的“可操作性”，探索向交互式文檔平台演進。支持在生成的API文檔中嵌入輕量級測試工具，允許開發者直接於文檔界面調試接口；同時可集成團隊評審、疑問標註、邏輯修正建議等協作功能，使文檔不僅是靜態參考，更成為開發生命週期中的動態協作節點，推動知識高效流轉與團隊效能提升。
