# EFlow_api

**Repository Path**: roy-huang/eflow_api

## Basic Information

- **Project Name**: EFlow_api
- **Description**: 易程OA（EFlow）项目后端仓库
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2023-10-21
- **Last Updated**: 2024-09-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 易程OA（EFlow）后端

## 一、数据库地址

* MySql:
    * url: 124.221.242.12
    * 端口: 33306
    * 用户: root
* Redis：
    * url: redis://124.221.242.12:63379

## 二、开发规范

### 2.1 代码推送

统一在 dev 分支开发

当一个模块完成，合并到主分支

### 2.2 函数注解

所有工具类、公共函数，尽量使用函数注解

例如：

```python
def func(name: str, info: list, d: dict, num: int = 1) -> list:
    return []
```

### 2.3 接口注释

```python
class ExampleView():
    def get(self):
        """
        接口功能描述
        请求方式：GET
        URL: http://127.0.0.1/api/v1/example
        请求参数: 
            number: 电话号码
            user_id: 用户id
        """
        pass
```

注意：当继承视图Mixin类实现接口时，将接口注释写在类注释上