# EasyListApi

**Repository Path**: gdndzzk/easylistapi

## Basic Information

- **Project Name**: EasyListApi
- **Description**: 帮群友写的简易存储后端
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-12-20
- **Last Updated**: 2024-12-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# API 文档

## 1. 接口概述

以下文档描述了一个基于 Flask 框架的简易数据管理 API。该 API 提供了对一个数据表的基本操作，包括添加、查询、删除等。所有都需要通过 API 密钥进行验证。

数据会自动写入 `database.sqlite`，直接通过内存查询保证速度。

## 2. 配置信息

- **PORT**: 服务器监听的端口号。
- **API_KEY**: 用于接口调用的密钥。

## 3. 数据库结构

- **表名**: `k`
- **字段**:
  - `v`: 文本类型，存储键值对的值。

## 4. 接口详情

### 4.1 添加数据

- **URL**: `/add`
- **方法**: GET
- **参数**:
  - `apikey`: (必选) API 密钥。
  - `v`: (必选) 要添加的值。
- **返回格式**:

```json
{
  "success": true|false
}
```

- **说明**: 如果值成功添加到数据库，返回 `true`，否则返回 `false`。

### 4.2 查询数据

- **URL**: `/query`
- **方法**: GET
- **参数**:
  - `apikey`: (必选) API 密钥。
  - `v`: (必选) 要查询的值。
- **返回格式**:

```json
{
  "success": true|false
}
```

- **说明**: 如果值存在于数据库中，返回 `true`，否则返回 `false`。

### 4.3 查询所有数据

- **URL**: `/query_all`
- **方法**: GET
- **参数**:
  - `apikey`: (必选) API 密钥。
- **返回格式**:

```json
{
  "success": [
    "value1",
    "value2",
    ...
  ]
}
```

- **说明**: 返回数据库中所有值的列表。

### 4.4 删除数据

- **URL**: `/delete`
- **方法**: GET
- **参数**:
  - `apikey`: (必选) API 密钥。
  - `v`: (必选) 要删除的值。
- **返回格式**:

```json
{
  "success": true|false
}
```

- **说明**: 如果值成功从数据库中删除，返回 `true`，否则返回 `false`。

### 4.5 删除所有数据

- **URL**: `/delete_all`
- **方法**: GET
- **参数**:
  - `apikey`: (必选) API 密钥。
- **返回格式**:

```json
{
  "success": true
}
```

- **说明**: 删除数据库中所有数据，总是返回 `true`。

## 5. 错误响应

- **错误码**: 403
- **返回格式**:

```json
{
  "error": "Invalid API_KEY"
}
```

- **说明**: 当提供的 API 密钥无效时，将返回此错误响应。

## 6. 注意事项

- 所有接口都通过 GET 方法调用，并且都需要在请求参数中提供有效的 `apikey`。
- 所有接口的返回数据都是 JSON 格式。
- 参数 `v` 应进行 URL 编码。
- 确保服务器配置了正确的 `PORT` 和 `API_KEY`。
- 如果 API 密钥验证失败，将返回 403 状态码和错误信息。