@artale/pi-api

多框架API开发工具包，支持路由扫描与OpenAPI生成。

安装使用

复制下面这段提示词发给你的 AI（Claude / Cursor / TRAE / Codex / WorkBuddy 等），它会自动帮你完成安装：

帮我安装这个 AI Skill：@artale/pi-api。
它的用途是：多框架API开发工具包，支持路由扫描与OpenAPI生成。
详细介绍见：https://321skill.com/skills/artale-pi-api/
请根据该页面的说明完成安装。

‘请使用@artale/pi-api为我的Express项目生成OpenAPI文档。’ 它会引导你安装该工具包，并执行扫描命令，最终输出一个标准的OpenAPI规范文件。或者，你可以要求它‘对FastAPI项目的所有端点进行冒烟测试’，它会调用工具的相关功能来验证接口的可用性。

该工具旨在解决API开发过程中路由管理混乱、文档与代码不同步以及接口测试繁琐的问题。开发者通常需要手动维护路由列表、编写接口文档并进行重复的端点测试，此工具通过自动化扫描来简化这些流程。

它通过扫描项目中的路由文件（支持Express、Next.js、Flask、FastAPI等主流框架），自动识别所有API端点，并可以对这些端点进行测试。同时，它能基于扫描结果自动生成符合OpenAPI规范的接口文档，确保文档与代码实时同步。

适合后端开发工程师、全栈开发者以及需要为API提供标准化文档的团队使用。尤其是在开发或维护中型以上、接口数量较多的Web服务项目时，能显著提升效率。

使用建议是将其集成到开发或CI/CD流程中，以便在代码变更时自动更新文档。需要注意的是，它主要依赖框架特定的路由定义模式进行扫描，对于高度自定义或非标准的路由结构可能需要进行额外配置。

与单一框架的API文档生成工具不同，它同时支持Node.js（Express/Next）和Python（Flask/FastAPI）两大生态的多个主流Web框架，实现了跨语言、跨框架的统一工作流。其核心功能集成了路由扫描、端点测试和文档生成，提供了一个从开发到测试再到文档的闭环工具链。

不适合路由逻辑高度定制化、无法通过常规模式扫描的项目，或仅需要生成静态API文档而无动态测试需求的场景。

支持Koa或Django吗？

目前主要支持Express, Next.js, Flask, FastAPI，暂未官方支持Koa和Django。

生成的OpenAPI文档准确吗？

文档基于代码中的路由结构自动生成，准确性取决于框架标准用法和工具扫描的深度。