# 文档预览-编辑系统api

**Repository Path**: huangzhiwendemayun/preview_and_edit_online

## Basic Information

- **Project Name**: 文档预览-编辑系统api
- **Description**: 文档的在线预览和编辑，使用的是金山文档的sdk
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 0
- **Created**: 2021-01-15
- **Last Updated**: 2024-07-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

负责人： 黄志文

| 评分人 |  评分时间 | 评分 | 备注 |
| --- |  --- | --- | --- |
| Mark |    |  |  |
| 罗文  |    |  |  |
| 杨宁 |    |  |  |
| 朱淼 |    |  |  |



插件地址：https://test.pypi.org/project/lqqh-online-preview-edit-huangzhiwen/0.0.1/
安装方式：pip install -i https://test.pypi.org/simple/ lqqh-online-preview-edit-huangzhiwen==0.0.1
源码地址：https://gitee.com/huangzhiwendemayun/preview_and_edit_online.git
当前版本：0.0.1
demo地址:https://gitee.com/huangzhiwendemayun/preview_and_edit_online_demo.git
demo yapi测试地址：http://myyapi.blueballon.cn/project/19/interface/api

使用方法
app.py文件中写入以下代码

```
from lqqh_online_preview_and_edit.wps import wps_bp
app.register_blueprint(wps_bp, url_prefix='/api/v1.0/wps/v1/3rd')
```

setting.py文件中写入以下代码
```
FILE_DOWNLOAD_URL = 'http://test.blueballon.cn' #文件下载的url地址
APPID = "21c4bd133f2a47ce95c3f2d2f06dad2f"   #开发信息中的APPID,需要在https://open.wps.cn/docs/cloud/case-solution中申请
APPKEY = "d8a8e226e6d74b0e903c866143d0cf6c"  #开发信息中的APPKEY,需要在https://open.wps.cn/docs/cloud/case-solution中申请
DOMAIN = "http://wwo.wps.cn" #金山文档在线编辑域名(不需要修改)
MODOLE_FILE_PATH = "file" #本项目File model所在的文件名
MODOLE_USER_PATH = "user" #本项目User model所在的文件名
ROOT_DIR_URL = "/Users/hzw/lqq_project/test_wps/model" #模型根目录
FILE_CLASS_NAME = 'File' #文件model名
# 设置本项目中文件对象的属性名，比如在本项目中文件名的属性名为c_name c_version 
# c_size create_user create_time update_user update_time c_url则：
FILE_ATTR_NAME_MAP = {
'name': 'c_name',
'version': 'c_version',
'size': 'c_size',
'creator': 'create_user',
'create_time': 'create_time',
'modifier': 'update_user',
'modify_time': 'update_time',
'download_url': 'c_url'
}
USER_CLASS_NAME = 'User'
# 设置本项目中用户对象的属性名
USER_ATTR_NAME_MAP = {
'name': 'c_name',
'avatar_url': 'c_photo_url'
}
# 设置新版本和老版本文件数据需要相同的属性名,比如新版本和老版本文件名都一样，则把c_name加入到列表中。。
NEW_OLD_NEED_SAME_ATTR_LIST = ['c_name']
```
需要在项目根目录创建一个do_yourself.py文件并且文件中实现以下函数
```
def get_user_file_permission(userid, file_id):
    """获取用户对这个文件的权限，需要开发者根据自己的项目自己实现

    Args:
        userid (str): 用户的id
        file_id (str): 文件的id
    Returns:
        str:
            返回'read'说明这个用户只可预览这个文件
            返回'write'说明这个用户可预览可编辑这个文件
    """
    return
```