https://github.com/budali/weixin_cloud
https://github.com/budali/weixin_cloud
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/budali/weixin_cloud
- Owner: budaLi
- License: mit
- Created: 2022-08-25T01:54:55.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-08-25T01:55:09.000Z (almost 4 years ago)
- Last Synced: 2025-03-05T13:25:48.267Z (over 1 year ago)
- Language: HTML
- Size: 9.77 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# wxcloudrun-flask
[](https://github.com/WeixinCloud/wxcloudrun-express)
微信云托管 python Flask 框架模版，实现简单的计数器读写接口，使用云托管 MySQL 读写、记录计数值。
## 快速开始
前往 [微信云托管快速开始页面](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/basic/guide.html)，选择相应语言的模板，根据引导完成部署。
## 本地调试
下载代码在本地调试，请参考[微信云托管本地调试指南](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/debug/)
## 实时开发
代码变动时，不需要重新构建和启动容器，即可查看变动后的效果。请参考[微信云托管实时开发指南](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/debug/dev.html)
## Dockerfile最佳实践
请参考[如何提高项目构建效率](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/scene/build/speed.html)
## 目录结构说明
~~~
.
├── Dockerfile dockerfile dockerfile
├── README.md README.md README.md文件
├── container.config.json 模板部署「服务设置」初始化配置（二开请忽略）
├── requirements.txt 依赖包文件
├── config.py 项目的总配置文件 里面包含数据库 web应用 日志等各种配置
├── run.py flask项目管理文件 与项目进行交互的命令行工具集的入口
└── wxcloudrun app目录
├── __init__.py python项目必带 模块化思想
├── dao.py 数据库访问模块
├── model.py 数据库对应的模型
├── response.py 响应结构构造
├── templates 模版目录,包含主页index.html文件
└── views.py 执行响应的代码所在模块 代码逻辑处理主要地点 项目大部分代码在此编写
~~~
## 服务 API 文档
### `GET /api/count`
获取当前计数
#### 请求参数
无
#### 响应结果
- `code`：错误码
- `data`：当前计数值
##### 响应结果示例
```json
{
"code": 0,
"data": 42
}
```
#### 调用示例
```
curl https://<云托管服务域名>/api/count
```
### `POST /api/count`
更新计数，自增或者清零
#### 请求参数
- `action`：`string` 类型，枚举值
- 等于 `"inc"` 时，表示计数加一
- 等于 `"clear"` 时，表示计数重置（清零）
##### 请求参数示例
```
{
"action": "inc"
}
```
#### 响应结果
- `code`：错误码
- `data`：当前计数值
##### 响应结果示例
```json
{
"code": 0,
"data": 42
}
```
#### 调用示例
```
curl -X POST -H 'content-type: application/json' -d '{"action": "inc"}' https://<云托管服务域名>/api/count
```
## 使用注意
如果不是通过微信云托管控制台部署模板代码，而是自行复制/下载模板代码后，手动新建一个服务并部署，需要在「服务设置」中补全以下环境变量，才可正常使用，否则会引发无法连接数据库，进而导致部署失败。
- MYSQL_ADDRESS
- MYSQL_PASSWORD
- MYSQL_USERNAME
以上三个变量的值请按实际情况填写。如果使用云托管内MySQL，可以在控制台MySQL页面获取相关信息。
## License
[MIT](./LICENSE)