swagger-api-cli
v1.0.0
Published
API 文档查询 CLI 工具 — 通过本地 SQLite + FTS5 全文搜索快速查询 OpenAPI/Swagger 接口
Readme
swagger-api-cli
API 文档查询 CLI 工具。拉取 Swagger/OpenAPI /v3/api-docs 文档,解析所有接口写入本地 SQLite 数据库,支持全文搜索。
- 全文搜索:SQLite FTS5(BM25 相关性排序),无需外部依赖
- 离线查询:一次拉取,后续完全离线
- 即装即用:无需任何 API Key
安装
cd swagger-api-cli
npm install
npm run build全局安装后可随处使用:
npm link
swagger-api-cli --help使用
# 1. 拉取文档
swagger-api-cli load http://192.168.1.183:8021/v3/api-docs --reset
# 2. 搜索接口
swagger-api-cli search 项目
swagger-api-cli search 导出用户
# 3. 查看接口详情
swagger-api-cli detail GET:/system/funds/project/list
# 4. 按模块浏览
swagger-api-cli list --tag 科研经费
# 5. 列出所有模块
swagger-api-cli tags
# 6. 查看统计
swagger-api-cli stats环境变量
| 变量 | 说明 | 默认值 |
|------|------|--------|
| DATA_DIR | SQLite 数据库存储目录 | ./data |
目录结构
swagger-api-cli/
├── src/
│ ├── index.ts # CLI 入口
│ ├── storage.ts # SQLite + FTS5 存储封装
│ ├── swagger.ts # Swagger 文档拉取、解析
│ └── types.ts # 类型定义
├── dist/ # 编译产物
├── data/ # SQLite 数据库(自动创建)
└── package.json