一、产品介绍

可部署至「本地服务器」或「专有云服务器」的WEB API服务，支持垃圾分类信息查询服务，在专有网络环境下部署应用，保障数据私密性，提供一键启动软件部署包私有化方案。详情可点击: https://www.juhe.cn/papi/rubbish 进行了解。

二、使用教程

下载部署包

通过聚合官方网站下载对应的Linux版本私有部署包(*目前暂支持64位系统)，比如下载的压缩包版本为: jrubbish-1.0.0-x86_64.tar.gz，将压缩包上传至服务器。
进入压缩包所在的文件目录，通过tar命令解压，比如所在目录为: /data/download

# 进入目录
cd /data/download/

# 解压
tar zxvf jrubbish-1.0.0-x86_64.tar.gz

# 进入程序目录
cd jrubbish-1.0.0-x86_64

解压私有部署包后，进入程序目录，可以看到如下文件:

文件目录介绍:
-- data/rubbish_1.0.0.txt 为数据文件 (当然您也可以直接进行数据修改、更新或封装成其他程序服务)
-- docs/index.html 为接口调用基本说明文档
-- server 为服务主程序

启动API服务

1. 进入程序目录

 cd jrubbish-1.0.0-x86_64

2. 启动服务

 ./server

3. 服务默认的端口为8369，如果该端口被占用或需自定义端口，启动时可以使用--port参数指定端口，例如:

./server --port 8368

4. 如需系统后台不挂断地运行，可以使用nohup命令启动服务，例如:

nohup ./server 2>&1 &

您也可以使用其他的比如supervisor等管理工具实现。

如启动结果如下图显示，说明启动服务成功!

调用API服务

本地API服务启动成功后，您即可通过提供的API地址进行接口请求了。

比如上一步示例启动的服务 (具体服务的IP和端口以实际为准)，您可以通过:

接口文档地址

(浏览器访问,查看完整接口文档说明)

http://127.0.0.1:8369/docs
或
http://10.0.49.15:8369/docs

接口请求地址

API接口地址:

http://127.0.0.1:8369/query
或
http://10.0.49.15:8369/query

API接口参数简易参照 (GET请求接口，进行调用):

API接口请求参数示例:

# GET参数中keyword的值即为需要查询的urlencode后的垃圾名称或关键词
curl "http://10.0.49.15:9369/query?keyword=%E5%B0%8F%E9%BE%99%E8%99%BE

接口响应内容示例:

{
    "code": 0,
    "msg": "查询成功",
    "result": [
        {
            "item_name": "整只小龙虾",
            "category_name": "湿垃圾"
        },
        {
            "item_name": "小龙虾头",
            "category_name": "湿垃圾"
        },
        {
            "item_name": "小龙虾",
            "category_name": "湿垃圾"
        },
        {
            "item_name": "小龙虾壳",
            "category_name": "湿垃圾"
        },
        {
            "item_name": "小龙虾黄",
            "category_name": "湿垃圾"
        },
        {
            "item_name": "小龙虾肉",
            "category_name": "湿垃圾"
        }
    ]
}

*具体接口返回格式及说明，请参照接口文档