# 私人书库Lite_Server

**Repository Path**: walkline/private-bookstore-lite_server

## Basic Information

- **Project Name**: 私人书库Lite_Server
- **Description**: 私人书库Lite 服务器端
- **Primary Language**: PHP
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2017-05-15
- **Last Updated**: 2022-05-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 私人书库 Lite - Server

[私人书库 Lite][private-bookstore-lite] 的服务器端，是使用PHP编写的RESTful API程序

## 命令列表

> 全部命令必须使用POST方法传递参数

	util/v1/getbooklists    获取小说列表（用于首页、管理页）
	util/v1/removebook      删除指定的小说（用于管理页）
	util/v1/appendbook		添加指定的小说（用于管理页）
	util/v1/checkupdate		检查更新（用于关于页）
	util/v1/updatehstory	更新小说阅读历史记录（用于章节内容页）

## 功能介绍

#### 获取小说列表

`util/v1/getbooklists`

**返回用户添加的所有小说列表**

参数：

- `uid`：用户登录时的id（必选）
- `limit`：分页列表数量，`默认值为0`，获取全部列表（可选）
- `page`：分页序号，`默认值为0`，`limit>0`时显示指定分页的列表（可选）

返回值：`json`

	{
	    "total_counts": 5,
	    "list_counts": 3,
	    "lists": [
	        {
	            "bid": "12539",
	            "title": "灵车",
	            "author": "堂前雁",
	            "history": {
	                "article_title": "第一百八十五章 生死之间",
	                "article_page": "1237854"
	            }
	        },
	        ......
	    ],
	    "paging": {
	        "current_page": 0,
	        "paging_counts": 2,
	    }
	}

返回值说明：

- `total_counts`：小说总数
- `list_counts`：本次获取的小说数量
- `lists`：本次获取的小说列表集合
- `bid`：小说id（用于获取小说主页内容）
- `title`：小说标题
- `author`：小说作者
- `history`：小说阅读历史记录
- `article_title`：小说章节标题
- `article_page`：小说章节页面id（用于获取小说章节内容）
- `current_page`：当前显示的分页页面编号，第一页为0
- `paging_counts`：分页总数


#### 删除指定的小说

`util/v1/removebook`

**删除用户指定的一本小说，并删除相关的历史记录**

参数：

- `uid`：用户登录时的id（必选）
- `bid`：待删除小说的id（必选）
- `include_history`：删除小说同时删除阅读历史记录，`默认值为true`

返回值：`json`

	{
	    "result": true,
	    "result_history": true
	}

返回值说明：

- `result`：删除指定小说的结果
- `result_history`：删除指定小说阅读历史记录的结果

> 说明：返回值数据由[mysql_query()][mysql_query]提供，但无论是否真的删除记录，返回值都为`true`


#### 添加指定的小说

`util/v1/appendbook`

**添加用户指定的一本小说**

参数：

- `uid`：用户登录时的id（必选）
- `bid`：待添加小说的id（必选）
- `title`：待添加小说的名称（必选）
- `author`：待添加小说的作者（必选）

返回值：`json`

	{
	    "result": true,
	}

返回值说明：

- `result`：添加指定小说的结果

#### 检查更新

`util/v1/checkupdate`

**检查是否有新版本，并提供下载地址**

参数：

- `app_code`：app识别代码，例如`private-bookstore-lite`
- `version_code`：app当前版本号代码，例如`101`，代表当前版本号为`1.0.1`

返回值：`json`

	{
	    "app_code": "private-bookstore-lite",
	    "version_code": 101,
	    "version_name": "1.0.1",
	    "msg": [
	        "1、界面优化；",
	        "2、优化性能；",
	        "3、增加功能。"
	    ],
	    "url": "http://path/to/your/apk_file"
	}

- `app_code`：app识别代码
- `version_code`：最新版本号代码
- `version_name`：最新版本号名称
- `msg`：更新说明集合
- `url`：最新版本apk文件下载地址

#### 检查更新的配置文件 `config.php`

**将`util/v1/function/config.sample.php`按需修改后改名为`config.php`即可**

> `versions_file`指向的文件说明如下

#### 检查更新的配置文件 `versions.json`

**将`util/v1/function/versions.sample.json`按需修改后改名为`versions.json`，并存放到`versions_file`所指向的位置即可**

文件格式：`json`

	{
	    "apps": [
	        {
	            "app_code": "private-bookstore-lite",
	            "version_code": 100,
	            "version_name": "1.0.0",
	            "msg": [
	                "界面优化",
	                "优化性能",
	                "增加功能"
	            ],
	            "url": "http://path/to/your/apk_file"
	        },
	        ......
	    ]
	}

- `apps`：需要在线更新功能的app集合
- `app_code`：app识别代码
- `version_code`：最新版本号代码
- `version_name`：最新版本号名称
- `msg`：更新说明集合
- `url`：最新版本apk文件下载地址

> 重要说明：该文件为手动录入，为避免异常请特别注意如下两点

> - 确保文件格式为`UTF-8`，且不包含`BOM`
> - 确保`json`格式正确，如果没有`msg`更新说明，使用`"msg": [],`替代模板文件对应内容

#### 更新阅读历史记录

`util/v1/updatehistory`

**更新小说当前阅读记录**

参数：

- `uid`：用户登录时的id（必选）
- `bid`：待更新记录小说的id（必选）
- `article_title`：待更新记录的章节名称（必选）
- `article_id`：待更新记录的章节id（必选）

返回值：`json`

	{
	    "result": true,
	}

返回值说明：

- `result`：更新小说阅读记录的结果

## 更新日志

	2017-06-02
		修复checkupdate文件名大小写错误

	2017-05-21
		完成 更新阅读历史记录 功能

	2017-05-19
		1、完成 检查更新 功能
		2、提供数据库结构文件

	2017-05-18
		完成 添加指定小说 功能

	2017-05-16
		完成 删除指定小说 功能

	2017-5-15
		1、完成 获取小说列表 功能
		2、创建项目



[private-bookstore-lite]: http://git.oschina.net/walkline/private-bookstore-lite
[mysql_query]: http://www.php.net/mysql_query