name: api-push-product-platform description: 推送後端 API 介面定義資料到產品部資料平臺。

API Push Product Platform

將後端 Java 介面定義（請求方法、路徑、引數、響應結構）推送到產品部資料平臺，實現介面文件的集中管理和同步。

觸發場景

• 後端完成介面開發後推送到產品部資料平臺
• 批次推送、增量更新、推送歷史查詢
• 產品需求（PRD）關聯的介面文件同步

核心資訊

• 推送地址: http://test-gateway.jinyi999.cn/rjhy-test-compliance-utils-api/api/v1/aitest/backend/message
• 方法: POST
• Content-Type: application/json
• 請求體引數:
• prdid (必填): 產品需求 ID
• content (必填): 介面文件 JSON 資料（主要是後端 Java 介面定義）

請求示例

{
  "prdid": "PRD-2026-001",
  "content": {
    "apis": [
      {
        "method": "GET",
        "path": "/api/users/{id}",
        "description": "獲取使用者詳情",
        "parameters": [...],
        "response": {...}
      }
    ]
  }
}

工作流程

1. 獲取產品需求 ID（prdid）
2. 準備介面定義資料（Java 介面定義的 JSON 格式）
3. 執行推送指令碼或 API 呼叫
4. 驗證推送結果

   更多技能請訪問小蔥技能站7w4.net。

5. 記錄推送歷史到 references/push-history.md

使用方式

自然語言（推薦）：直接告訴我需求，我引導你完成推送

指令碼方式：

python3 scripts/push_api_to_product_platform.py --prdid "PRD-2026-001" --file ./api-definitions.json

直接 API：參考 references/product-platform-api-docs.md

介面定義格式

支援： - 標準 JSON 格式 - Spring Boot Controller 註解提取 - Java 介面描述 - Swagger/OpenAPI 3.0 轉換

詳細格式規範見 references/api-definition-standard.md

錯誤處理

常見錯誤場景： - 網路錯誤：重試機制（最多 3 次） - 引數格式錯誤：檢查 JSON 格式和必填欄位（prdid, content） - PRD ID 不存在：確認產品需求 ID 是否正確 - 伺服器錯誤：記錄詳細錯誤日誌並聯系平臺管理員

推送前驗證介面定義完整性、引數清晰、響應結構明確。

最佳實踐

• 推送前檢查：介面定義完整、引數清晰、響應結構明確
• 批次推送：按模組分組，每次 < 50 個介面
• 版本管理：標註新增/修改/廢棄介面
• 通知相關人員：推送完成後提供變更說明
• 記錄歷史：每次推送記錄到 references/push-history.md

詳細實踐見 references/product-platform-api-docs.md

相關文件

• 產品部資料平臺 API 文件
• 介面定義規範
• 推送歷史記錄

自動化整合

支援 CI/CD 整合和 Git Hook 整合，配置示例見 references/product-platform-api-docs.md

這個 Skill 質量還不錯，文件寫得很清楚，一看就知道是用來做什麼的。核心功能明確，有指令碼可用，操作流程也寫得很詳細。不足之處是缺少實際使用案例，歷史記錄功能只是空殼子，沒有真實資料參考，而且部分文件內容有些重複，看起來有點囉嗦。對於日常使用來說基本夠用，但如果能加上幾個完整的推送示例會更好。總體評價：能用，但還有提升空間。