开源软件名称:WeixinCloud/wxcloudrun-koa
开源软件地址:https://github.com/WeixinCloud/wxcloudrun-koa
开源编程语言:
HTML
74.2%
开源软件介绍:wxcloudrun-koa
微信云托管 Node.js Koa 框架模版,实现简单的计数器读写接口,使用云托管 MySQL 读写、记录计数值。
快速开始
前往 微信云托管快速开始页面,选择相应语言的模板,根据引导完成部署。
本地调试
下载代码在本地调试,请参考微信云托管本地调试指南
实时开发
代码变动时,不需要重新构建和启动容器,即可查看变动后的效果。请参考微信云托管实时开发指南
Dockerfile最佳实践
请参考如何提高项目构建效率
项目结构说明
.
├── Dockerfile
├── README.md
├── container.config.json
├── db.js
├── index.js
├── index.html
├── package.json
index.js :项目入口,实现主要的读写 API
db.js :数据库相关实现,使用 sequelize 作为 ORM
index.html :首页代码
package.json :Node.js 项目定义文件
container.config.json :模板部署「服务设置」初始化配置(二开请忽略)
Dockerfile :容器配置文件
服务 API 文档
GET /api/count
获取当前计数
请求参数
无
响应结果
响应结果示例
{
"code": 0,
"data": 42
}
调用示例
curl https://<云托管服务域名>/api/count
POST /api/count
更新计数,自增或者清零
请求参数
action :string 类型,枚举值
- 等于
"inc" 时,表示计数加一
- 等于
"clear" 时,表示计数重置(清零)
请求参数示例
响应结果
响应结果示例
{
"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
|
请发表评论