NebulaAPI - 万物皆 API

NebulaAPI 是一个轻量级、灵活且强大的 RESTful API 框架，旨在将任何数据源快速转化为 API。无论是 CSV、Excel、Pandas DataFrame，还是 MongoDB 等数据源，NebulaAPI 都能轻松将其转化为可用的 API，并提供自动化的路由生成和强大的扩展能力。

核心功能

1. 万物皆 API

任何数据源都可以转化为 API：无论是结构化数据（如 CSV、Excel、DataFrame）还是非结构化数据（如 MongoDB、JSON 文件），NebulaAPI 都能将其快速转化为 RESTful API。
基于 Excel 文件的数据源：NebulaAPI 允许你直接使用 Excel 文件作为数据源，无需数据库，即可提供数据服务，适合小型项目或快速原型开发。

2. 支持多种数据格式

CSV/Excel 自动转化：直接传入 CSV 或 Excel 文件，NebulaAPI 会自动解析数据并生成对应的 API。
Pandas DataFrame 支持：可以直接传入 Pandas DataFrame，NebulaAPI 会将其转化为 API。
MongoDB 支持：通过传入 MongoDB 连接字符串，NebulaAPI 可以自动将 MongoDB 集合转化为 API。

3. 自动化与灵活性并存

自动生成 API：NebulaAPI 会自动为每个数据表生成标准的 CRUD（增删改查）API，无需手动编写代码。
支持手动扩展：除了自动生成的 API，你还可以手动注册自定义路由，灵活控制 API 的行为。
自定义 CRUD 逻辑：通过自定义 CRUD 类，你可以完全控制数据的处理逻辑，满足复杂业务需求。

4. Swagger 文档支持

自动生成 API 文档：NebulaAPI 会自动生成 Swagger 文档，方便开发者查看和测试 API。
实时更新：每次注册新的路由或修改现有路由时，Swagger 文档都会自动更新。

5. 强大的查询能力

灵活的条件查询：支持通过字典条件进行查询、更新和删除操作，满足复杂的数据过滤需求。
分页支持：自动为数据表添加分页功能，方便处理大量数据。

快速开始

安装依赖

确保你已经安装了 Flask 和 Pandas 还有NebulaDataEngine：

pip install Flask pandas  NebulaDataEngine

示例 1：从 Excel 文件生成 API

假设你有一个 products.xlsx 文件，内容如下：

id	name	price	category
1	Apple	0.5	Fruit
2	Banana	0.3	Fruit
3	Carrot	0.2	Vegetable
4	Date	2.0	Fruit

通过以下代码，你可以将 products.xlsx 转化为 API：

from nebula_api_v3 import NebulaAPI

# 初始化 NebulaAPI，传入 Excel 文件路径
api = NebulaAPI(data_source="products.xlsx", enable_docs=True, enable_crud=True)

# 启动服务器
api.run_server(host='localhost', port=5000)

启动后，你可以访问api文档地址 http://localhost:5000/api/docs/#/ 可以看到以下接口：

获取所有产品：
```
GET /api/products
```
添加新产品：
```
POST /api/products/add
```
更新产品信息：
```
PUT /api/products/edit/{id}
```
删除产品：
```
DELETE /api/products/delete/{id}
```
通过条件查询产品：
```
POST /api/products/find
```

示例 2：从 Pandas DataFrame 生成 API

如果你已经有 Pandas DataFrame，可以直接将其转化为 API：

from nebula_api_v3 import NebulaAPI
import pandas as pd

# 创建示例 DataFrame
data = {
    'user': pd.DataFrame({
        'id': [1, 2, 3, 4],
        'name': ['Alice', 'Bob', 'Charlie', 'David'],
        'age': [24, 27, 22, 32],
        'city': ['New York', 'Los Angeles', 'Chicago', 'Houston']
    })
}

# 初始化 NebulaAPI，传入 DataFrame
api = NebulaAPI(data_source=data, enable_docs=True, enable_crud=True)

# 启动服务器
api.run_server(host='localhost', port=5000)

示例 3：自定义 CRUD 逻辑

如果你想自定义 CRUD 逻辑，可以通过以下方式实现：

from nebula_api_v3 import NebulaAPI
import pandas as pd

# 自定义 CRUD 类
class CustomCRUD:
    def __init__(self, data_engine, table_name):
        self.data_engine = data_engine
        self.table_name = table_name

    def add(self, data):
        # 自定义添加逻辑
        self.data_engine.save(data, self.table_name)
        return {"message": "数据添加成功（自定义逻辑）"}

    def edit(self, id, data):
        # 自定义更新逻辑
        data['id'] = id
        self.data_engine.save(data, self.table_name)
        return {"message": "数据更新成功（自定义逻辑）"}

    def delete(self, id):
        # 自定义删除逻辑
        self.data_engine.deleteById(id, self.table_name)
        return {"message": "数据删除成功（自定义逻辑）"}

    def get(self, id):
        # 自定义获取逻辑
        data = self.data_engine.findById(id, self.table_name)
        if data:
            return data
        else:
            return {"error": "数据未找到（自定义逻辑）"}, 404

# 初始化 NebulaAPI
api = NebulaAPI(data_source=data, enable_docs=True, enable_crud=True)

# 注册自定义 CRUD 逻辑
custom_crud = CustomCRUD(api.data_engine, "user")
api.register_custom_crud_routes("user", custom_crud)

# 启动服务器
api.run_server(host='localhost', port=5000)

适用场景

快速原型开发：无需编写大量代码，快速将数据转化为 API，加速开发进程。
数据共享：将内部数据（如 CSV、Excel）快速转化为 API，方便其他系统或团队使用。
微服务架构：将数据源封装为独立的 API 服务，支持微服务架构。
自动化测试：通过 Swagger 文档，方便进行 API 测试和调试。

未来计划

更多数据源支持：计划支持更多数据源，如 MySQL、PostgreSQL、Redis 等。
权限控制：增加 API 权限控制功能，支持 JWT 认证和角色管理。
性能优化：优化大数据量下的查询和分页性能。
重构底层：目前还有挺多的硬编码后期应该会改成基于语义的查询方法减少大量硬编码并增加基于语义的接口注册查询例如 find_user_by_name 直接传入方法或字符串等则会生成对应接口

贡献

欢迎贡献代码和提出建议！请通过 GitHub 提交 issue 或 pull request。

许可证

NebulaAPI 采用 MIT 许可证。详情请参阅 LICENSE 文件。

通过 NebulaAPI，你可以将任何数据源快速转化为 API，专注于业务逻辑，而无需担心繁琐的 API 实现细节。无论是快速原型开发还是生产环境，NebulaAPI 都能满足你的需求。

szw/NebulaApi

NebulaAPI - 万物皆 API

核心功能

1. 万物皆 API

2. 支持多种数据格式

3. 自动化与灵活性并存

4. Swagger 文档支持

5. 强大的查询能力

快速开始

安装依赖

示例 1：从 Excel 文件生成 API

示例 2：从 Pandas DataFrame 生成 API

示例 3：自定义 CRUD 逻辑

适用场景

未来计划

贡献

许可证

简介

发行版

贡献者

近期动态

szw/NebulaApi .gitee-modal { width: 500px !important; }

NebulaAPI - 万物皆 API

核心功能

1. 万物皆 API

2. 支持多种数据格式

3. 自动化与灵活性并存

4. Swagger 文档支持

5. 强大的查询能力

快速开始

安装依赖

示例 1：从 Excel 文件生成 API

示例 2：从 Pandas DataFrame 生成 API

示例 3：自定义 CRUD 逻辑

适用场景

未来计划

贡献

许可证

简介

发行版

贡献者

近期动态

搜索帮助

szw/NebulaApi