# funapi

**Repository Path**: farfarfun/funapi

## Basic Information

- **Project Name**: funapi
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-08-31
- **Last Updated**: 2026-10-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# funapi

OpenAPI 相关的小工具集：根据 OpenAPI/Swagger 文档一键生成 Python API 客户端代码，并提供 OpenAPI v2 转 v3 的辅助函数。核心生成逻辑基于 [openapi-python-client](https://github.com/openapi-generators/openapi-python-client) 封装。

## 安装

```bash
pip install funapi
```

## 用法示例

### 生成 API 客户端

```python
from pathlib import Path

from funapi.generate import generate_api

# 创建最小的 OpenAPI 3 文档
document = Path("openapi.json")
document.write_text(
    '''{
  "openapi": "3.0.3",
  "info": {"title": "Demo API", "version": "1.0.0"},
  "paths": {}
}''',
    encoding="utf-8",
)

# 根据本地 OpenAPI 文档生成客户端代码
generate_api(path=document, output_path=Path("demo_api_client"))
```

### OpenAPI v2 转 v3

```python
from funapi.convert import convert_openapi_v3

# 调用 https://converter.swagger.io 在线接口，将 v2 文档转换为 v3
convert_openapi_v3(
    openapi_filepath_ori="openapi-ori.json",
    openapi_filepath_v3="openapi-v3.json",
)
```

## 说明

- 没有命令行入口，需在 Python 代码中调用上述函数。
- `convert_openapi_v3` 依赖外部在线转换服务（converter.swagger.io），需要联网。

---

## 关于 farfarfun

[farfarfun](https://github.com/farfarfun) 是一个专注于实用工具库的开源组织，
涵盖云存储、数据处理、AI、多媒体与开发工具链等方向。

- 🏠 组织主页：<https://github.com/farfarfun>
- 📦 PyPI：<https://pypi.org/user/niuliangtao/>
- 📧 联系：farfarfun@qq.com

本项目基于 [MIT](LICENSE) 协议开源。