API文档速读:把第三方接口文档整理成可对接的速查材料

API文档速读是 SkillHub 社区 Skill(@user_70c2f807/api-doc-speed-reader,v1.0.0,knowledge-management),指导 Agent 在用户粘贴 API 文档后提取端点与参数、生成 curl/Python/JS 等示例、整理错误码与坑点,并可对比多份文档。无需 API Key。安装可通过 skillhub CLI 指定 Cursor、Claude Code、Codex 等 skills 目录,或下载官方 Zip。限制:不能仅凭外链读文档、不发起真实 HTTP、示例以粘贴内容为准。

閱讀全文
Apifox Helper:在編輯器裏把接口同步到 Apifox

Apifox Helper 是 SkillHub 社區 Skill(@user_3cf79a87/apifox-helper,v1.0.2),用於在用戶要求時將當前選中接口上傳或同步到 Apifox,或把 Controller 與路由處理函數導入 Apifox。需配置 API 密鑰(requires_api_key=true)。可通過 skillhub install 安裝到 Cursor、Claude Code、Codex 等對應 skills 目錄。適合減少改代碼後手工維護 Apifox 文檔的成本。

閱讀全文
FastAPI文檔自動生成:Swagger與OpenAPI的使用技巧

FastAPI的自動文檔功能基於OpenAPI規範,通過Swagger UI和ReDoc提供交互式接口文檔,可快速展示接口功能、參數及返回值,支持直接測試。啓用方式簡單:創建FastAPI應用,運行後訪問`/docs`(Swagger UI)或`/redoc`(ReDoc)即可查看。 核心技巧包括:用`FastAPI`構造函數參數設置全局信息(標題、描述、版本等);通過函數註釋、`Path`/`Query`工具類詳細描述接口和參數;用`tags`分類接口便於篩選;通過`include_in_schema=False`隱藏內部接口;使用Pydantic模型規範返回格式,或用`HTTPException`標註錯誤狀態碼。 這些方法可提升文檔清晰度與易用性,避免手動編寫維護的麻煩,確保接口信息與代碼一致,優化團隊協作與用戶體驗。

閱讀全文
FastAPI實戰:用GET和POST方法構建RESTful API

FastAPI是一個基於Python的現代Web框架,具有高性能(接近Node.js和Go)、自動生成API文檔(Swagger UI和ReDoc)、類型提示支持和易用性等優勢。環境準備需安裝FastAPI和uvicorn(推薦ASGI服務器)。 快速入門示例:創建根路徑接口(`@app.get("/")`),返回歡迎信息,運行命令爲`uvicorn main:app --reload`。GET方法實戰包括:①路徑參數(如`/users/{user_id}`),自動驗證類型;②查詢參數(如`/users/filter?name=張三`)實現過濾。POST方法需定義Pydantic模型(如`UserCreate`)接收JSON數據,自動驗證格式並生成新用戶。 FastAPI自動生成API文檔,訪問`http://localhost:8000/docs`(Swagger UI)或`/redoc`即可測試接口。總結其核心優勢:類型提示、數據驗證、交互式文檔,適合快速構建可靠RESTful API。

閱讀全文