Archived
删除历史版本, 初始化仓库
This commit is contained in:
MarkusJoe
37 files changed
+1773
No files matched your search
Whitespace-only changes.
+259
@@ -0,0 +1,259 @@
|
||||
# 这里是Request Counter的文档
|
||||
|
||||
> 虽然说项目很小根本不需要文档
|
||||
|
||||
# 工作原理
|
||||
|
||||
> Flask 建立服务器来接收请求并返回对应的响应体
|
||||
|
||||
# 部署
|
||||
|
||||
> 在部署之前你需要先安装`python3.10.x`以上的版本
|
||||
|
||||
## 部署到本地服务器
|
||||
|
||||
```shell
|
||||
$ git clone https://github.com/MarkusJoe/RequestCounter.git
|
||||
$ cd RequestCounter
|
||||
$ pip3 install -r requirements.txt
|
||||
$ python3 manage.py
|
||||
```
|
||||
|
||||
# 普通接口
|
||||
|
||||
## `/count/` 接口
|
||||
|
||||
> 必选参数: `name`: `str` 可选参数: `length`: `int` ; `theme`: `str`
|
||||
|
||||
### 调用示例
|
||||
|
||||
```shell
|
||||
$ curl -L -X https://requestcounter.herokuapp.com/count/test-example/
|
||||
```
|
||||
|
||||
```json
|
||||
"..."
|
||||
```
|
||||
|
||||
# API
|
||||
|
||||
* 注意事项
|
||||
|
||||
1. `/api/v1/`内的接口需要`key`来访问的有: `/export/` 可以将`key`放入请求头使用也可以作为查询参数使用
|
||||
2. `key`从环境变量中获取或者从`config.py`内的`Production`类的`SECRET_KEY`获取, 先判断环境变量是否存在如果不存在就使用`config.py`, 如果两个都存在则使用环境变量
|
||||
3. `key`的长度为`16`位的随机英文字母大小写字符串
|
||||
4. 目前需要`key`的接口有`export` `system`
|
||||
|
||||
> 地址前缀: `/api/v1/`
|
||||
|
||||
- 接口地址: `/overall/`, `/query/`, `/theme/`
|
||||
- 请求方法: `GET` `POST`
|
||||
|
||||
## 单元测试
|
||||
|
||||
> 通用
|
||||
|
||||
```shell
|
||||
$ python3 -m unittest app/tests/test_*
|
||||
```
|
||||
|
||||
> `Unix (Linux, Mac, etc.)`
|
||||
|
||||
```shell
|
||||
$ export FLASK_APP=manage.py
|
||||
$ flask test
|
||||
```
|
||||
|
||||
> `Windows CMD`
|
||||
|
||||
```shell
|
||||
set FLASK_APP=manage.py
|
||||
flask test
|
||||
```
|
||||
|
||||
> `Windows PowerShell`
|
||||
|
||||
```shell
|
||||
env:FLASK_APP=manage.py
|
||||
flask test
|
||||
```
|
||||
|
||||
## `key 使用示例`
|
||||
|
||||
> `key`的获取优先使用请求头内的数据
|
||||
|
||||
```python
|
||||
import requests
|
||||
|
||||
|
||||
def login_with_header():
|
||||
# 使用请求头登陆
|
||||
header = {'Authorization': 'bearer unittest'}
|
||||
resp = requests.get('http://127.0.0.1:5000/api/v1/system/', headers=header)
|
||||
print(resp.json())
|
||||
|
||||
|
||||
def login_with_query():
|
||||
# 使用查询参数登陆
|
||||
resp = requests.get('http://127.0.0.1:5000/api/v1/system/', params={'key': 'unittest'})
|
||||
print(resp.json())
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
login_with_header()
|
||||
login_with_query()
|
||||
|
||||
```
|
||||
|
||||
## `/overall/` 接口
|
||||
|
||||
> 使用此接口获取数据库中所有的数据
|
||||
|
||||
> 必选参数: `limit: int` > 自定义查询数量, 输入的数字大于等于最大值时, 将返回最大值
|
||||
|
||||
### 调用示例
|
||||
|
||||
```shell
|
||||
$ curl -L -X GET https://requestcounter.herokuapp.com/api/v1/overall/?limit=20
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"code": 200,
|
||||
"msg": "Success. Total: 7 row(s)",
|
||||
"data": [
|
||||
{
|
||||
"name": "sda",
|
||||
"times": 72
|
||||
},
|
||||
{
|
||||
"name": "main",
|
||||
"times": 59
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## `/query/` 接口
|
||||
|
||||
> 使用此接口获取数据库中指定的数据
|
||||
|
||||
***使用此接口查询的名称计数数值会加一***
|
||||
|
||||
> 必选参数: `name: str` > 查询指定名称的计数数据
|
||||
|
||||
> 可选参数: `nochange: Any`
|
||||
|
||||
> `nochange`: 'Any` > 将参数值设置为任意值则仅查询不增加
|
||||
|
||||
### 调用示例
|
||||
|
||||
```shell
|
||||
$ curl -L -X GET https://requestcounter.herokuapp.com/api/v1/query/?name=main&nochange=1
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"code": 200,
|
||||
"msg": "Success",
|
||||
"data": [
|
||||
"main",
|
||||
59
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## `/theme/` 接口
|
||||
|
||||
> 使用此接口获取数据库内原始的base64编码的主题图片
|
||||
|
||||
> 必选参数: `theme: str`
|
||||
|
||||
### 调用示例
|
||||
|
||||
```shell
|
||||
$ curl -L -X GET https://requestcounter.herokuapp.com/api/v1/theme/?name=lewd
|
||||
```
|
||||
|
||||
```json
|
||||
|
||||
{
|
||||
"code": 200,
|
||||
"msg": "Success",
|
||||
"data": [
|
||||
{
|
||||
"index": "...",
|
||||
"url": "...",
|
||||
"width": 45,
|
||||
"height": 100
|
||||
},
|
||||
"..."
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## `/alltables/` 接口
|
||||
|
||||
> 此接口可以获取数据库内所有的表名 > 返回的数据中不包含`ReqCount`
|
||||
|
||||
> 无参数
|
||||
|
||||
```shell
|
||||
$ curl -L -X GET https://requestcounter.herokuapp.com/api/v1/alltables/
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"code": 200,
|
||||
"msg": "Success",
|
||||
"data": [
|
||||
"..."
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## `/export/` 接口
|
||||
|
||||
> 此接口可以导出应用的数据库文件
|
||||
|
||||
> 无参数
|
||||
|
||||
### 调用示例
|
||||
|
||||
```shell
|
||||
$ curl -L -X GET https://requestcounter.herokuapp.com/api/v1/export/
|
||||
```
|
||||
|
||||
> 该接口请求成功后返回文件
|
||||
|
||||
## `/test/`接口
|
||||
|
||||
> 此接口仅用于测试 只能增加`test-example`名称的计数次数
|
||||
|
||||
> 无需`key`即可请求
|
||||
|
||||
### 调用示例
|
||||
|
||||
```shell
|
||||
$ curl -L -X GET https://requestcounter.herokuapp.com/api/v1/test/
|
||||
```
|
||||
|
||||
```json
|
||||
622
|
||||
```
|
||||
|
||||
> 返回一个`int`数字
|
||||
|
||||
# 关于
|
||||
|
||||
## 开源
|
||||
|
||||
- 本项目以Apache-2.0许可开源, 即:
|
||||
- 你可以直接使用该项目提供的功能, 无需任何授权
|
||||
- 你可以在**注明来源版权信息**的情况下对源代码进行任意分发和修改以及衍生
|
||||
|
||||
## 关于此页面
|
||||
|
||||
此文档由 [docsify](https://github.com/docsifyjs/docsify) 生成. docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 .md 转成 .html
|
||||
文件，所有转换工作都是在运行时进行。
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
|
||||
|
||||
# RequestCounter
|
||||
|
||||
> Python版的计数器
|
||||
|
||||
> 使用Python Flask 库完成的访问的次数计数器
|
||||
|
||||
* 响应速度快
|
||||
* 使用Sqlite3数据库操作
|
||||
|
||||
[GitHub](https://github.com/MarkusJoe/RequestCounter.git)
|
||||
[Get Started](#部署)
|
||||
File diff suppressed because one or more lines are too long.
|
After Width: | Height: | Size: 31 KiB |
@@ -0,0 +1,23 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<title>RequestCounter 帮助文档</title>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
|
||||
<meta name="description" content="Description">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
|
||||
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
|
||||
</head>
|
||||
<body>
|
||||
<div id="app"></div>
|
||||
<script>
|
||||
window.$docsify = {
|
||||
name: 'RequestCounter',
|
||||
repo: 'https://github.com/MarkusJoe/RequestCounter',
|
||||
coverpage: true
|
||||
}
|
||||
</script>
|
||||
<!-- Docsify v4 -->
|
||||
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user