VSearcher

搭建API服务

该服务是基于vsearcheropen in new window库，使用flask将其进一步扩展为可提供API服务的应用。

这里提供三种搭建的方式，按照个人需求进行选择。

TIP

完整的HTTP的API接口请求文档，点击查看

方式1：常规搭建

  1. 安装python环境(version: 3.8+)
  2. 拉取仓库
git clone https://gitee.com/breath57/vs-api vs-api

TIP

  1. 我们以 vs-api 作为工程名，当然您也可以以任意您喜爱的名字作为工程名。
  2. 如果您想以某个版本，如0.0.1版，作为起始项目，那么请在 github 上的版本页下载相应的版本即可。
  1. 进入工程目录
cd vs-api
  1. 安装项目依赖
pip install -r ./requirements.txt
  1. 启动工程
flask run -h 0.0.0.0 -p 5000

TIP

-h指定ip地址，-p指定访问的端口号

  1. 即可访问API服务，例如：http://127.0.0.1:5000/v1/video/get

完整的HTTP的API接口请求文档，点击查看

方式2：Docker搭建

运行的前置条件

  • 主机有可用的docker环境
  • 主机可以正常访问外网拉取镜像
  1. 拉取镜像
docker pull breath57/vs-api-flask
  1. 创建容器并运行
docker run  -itd -p 3306:3306/tcp -p 33060:33060/tcp -p 5000:5000/tcp  breath57/vs-api-flask
  1. 通过http://localhost:5000访问服务

完整的HTTP的API接口请求文档，点击查看

方式3：vs-api.exe程序搭建

该程序是使用pyinstaller进行打包的flask应用。

提示

方式3只指支持window7+操作系统中使用

  1. 下载vs-api.exe程序文件
    点击下载 vs-api.exeopen in new window
  2. 双击exe文件运行
  3. 通过http://localhost:5000访问

TIP

当然，这里提供的vs-api.exe，端口号是5000，IP地址为127.0.0.1，若需要应对不同的需求，需要配合nginx进行端口转发。或者，使用方式4进行搭建API服务。

完整的HTTP的API接口请求文档，点击查看

方式4：改配置文件+打包

  1. 拉取仓库
git clone https://gitee.com/breath57/vs-api vs-api

TIP

  1. 我们以 vs-api 作为工程名，当然您也可以以任意您喜爱的名字作为工程名。
  2. 如果您想以某个版本，如0.0.1版，作为起始项目，那么请在 github 上的版本页下载相应的版本即可。
  1. 进入工程目录
cd vs-api
  1. 安装项目依赖
pip install -r ./requirements.txt
  1. 修改app/config/secure.py文件内容
HOST = '0.0.0.0' # IP地址
PORT = 5001 # 运行后端口号

TIP

HOST、PORT可以修改成自己实际项目使用的。

  1. 在项目的根目录下运行
pyinstaller vs-proxy.py -F --add-data  "app/models/db/vsearcher.db;./app/models/db" --nowindowed

TIP

若提示未安装pyinstaller
则应运行pip install pyinstaller进行安装

  1. 将得到的dist/vs-proxy.exe，双击运行。
  2. 通过http://HOST:PORT访问

完整的HTTP的API接口请求文档，点击查看