Metadata-Version: 2.4
Name: zt-fop-cli
Version: 0.0.2
Summary: ZT 接口管理平台 CLI
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: playwright>=1.40.0
Requires-Dist: requests>=2.31.0
Requires-Dist: click>=8.1.0
Requires-Dist: pyyaml>=6.0

# zt-fop-cli

FOP/ARK 接口查询命令行工具，用于登录并搜索接口、查看接口详情与响应说明。

## 环境要求

- Python `>=3.10`
- 可用浏览器（首次登录会自动打开）

## 安装

### 开发安装（源码）

```bash
pip install -e .
```

### 打包发布

```bash
python -m pip install --upgrade build twine
python -m build
twine upload dist/*
```

## 快速开始

### 1) 登录并缓存 Token

首次运行会打开浏览器，请完成登录。成功后会从 `localStorage` 读取 `micro-gosAdmin-Token` 并缓存到本地。

```bash
zt-fop-cli login
```

### 2) 搜索接口

```bash
zt-fop-cli interface search -k 库存
```

### 3) 查看接口详情（含响应说明）

```bash
zt-fop-cli interface detail 123456
```

## 全局参数
- `-o, --output`：输出格式，支持：
  - `json`（默认）
  - `human`（表格）

示例：

```bash
zt-fop-cli -o human interface search -k 订单
```

> 说明：`interface detail` 输出为一个合并对象，包含：
> - `interface_detail`：接口详情
> - `interface_resp`：接口响应说明

## 配置说明

默认配置目录：`~/.zt-fop-cli`
- Token 缓存：`~/.zt-fop-cli/fop_bearer_token.txt`
- 配置文件：`~/.zt-fop-cli/config.yaml`

可选配置项示例：

```yaml
browser_channel: chromium
```

## 环境变量（可选）

支持通过环境变量自动填充登录页账号密码（如 SSO 页面字段可用）：

- `ZT_SSO_USERNAME`
- `ZT_SSO_PASSWORD`

未设置时可在浏览器中手动完成登录。

## 命令一览

- `zt-fop-cli login`
  - 浏览器登录并缓存 Token
- `zt-fop-cli interface search -k <keyword>`
  - 模糊搜索接口
- `zt-fop-cli interface detail <interface_id> [--ability 1] [--customer-app-id PLM]`
  - 查询接口详情并同时返回响应说明
