Skip to content

Commit dd4d20d

Browse files
committed
docs: add api
1 parent fc95d9e commit dd4d20d

9 files changed

Lines changed: 87 additions & 1 deletion

File tree

lavcode-docs/docs/.vuepress/config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ const usagePages = [
1111
},
1212
{
1313
text: "进阶",
14-
children: ["command.md", "contribute.md"],
14+
children: ["command.md", "contribute.md", "api.md"],
1515
},
1616
];
1717

-220 KB
Loading

lavcode-docs/docs/usage/api.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# 云接口
2+
3+
Lavcode 支持通过接口的方式存取数据
4+
5+
在选择 “数据存储位置” 界面,选择云接口
6+
7+
输入接口地址和密码即可使用
8+
9+
本教程使用源码提供的 `lavcode-node` 快速部署接口
10+
11+
## 部署接口
12+
13+
Lavcode 没有提供直接用的接口,因为大多数人都不愿意将密码存储到别人那里,因此你需要自行部署
14+
15+
在源码 `lavcode-node` 文件夹中,提供了 `nodejs` + 腾讯云 `CloudBase` 的方式部署云接口
16+
17+
你需要按以下步骤进行
18+
19+
1. 一键部署
20+
21+
[![](https://main.qcloudimg.com/raw/67f5a389f1ac6f3b4d04c7256438e44f.svg)](https://console.cloud.tencent.com/tcb/env/index?action=CreateAndDeployCloudBaseProject&appUrl=https%3A%2F%2Fgithub.com%2Fhal-wang%2FLavcode&branch=main&workDir=lavcode-node)
22+
23+
2. 设置环境
24+
25+
添加环境变量 `SECRET_KEY`,作为云接口的密码,请尽量设置复杂密码并保管好
26+
27+
部署后在 “环境” -> “访问服务” 可以查看域名
28+
29+
设置环境变量步骤如下
30+
31+
(1) 选择 “我的应用”,点击 `Lavcode` 右侧的 “管理”
32+
33+
![管理](./api/mng.png)
34+
35+
(2) 点击编辑按钮,以打开编辑开关
36+
37+
![编辑环境变量](./api/edit.png)
38+
39+
(3) 点击 “新建环境变量” 按钮,输入键值对,然后点 “保存并部署”,等待部署完毕
40+
41+
![添加环境变量](./api/add.png)
42+
43+
3. 查看域名并连接
44+
45+
(1) 点击左侧菜单 “环境” -> “访问服务”,查看默认域名,也可以添加自定义域名
46+
47+
![查看域名](./api/url.png)
48+
49+
(2) 在 Lavcode 客户端,存储方式选择云接口,地址为 `https://域名/v1`,密码为前面的环境变量设置的密码
50+
51+
`https://env-yourenvid-123456789.ap-shanghai.app.tcloudbase.com/v1`
52+
53+
![登录](./api/login.png)
54+
55+
## lavcode-node 介绍
56+
57+
lavcode-node 使用了 nodejs 框架 [ipare](https://ipare.org),按 Restful 规范实现接口
58+
59+
接口的默认页面是 `swagger`,同样是由 [ipare](https://ipare.org) 自动生成,你可以通过修改源码的方式隐藏 `swagger`
60+
61+
## 本地运行
62+
63+
你也可以选择本地运行 `lavcode-node`
64+
65+
fork 并 clone 项目后,在 `lavcode-node` 目录下新增 `.env.local` 文件,内如如下
66+
67+
```
68+
SECRET_KEY=云接口密码
69+
ENV_ID=CloudBase 环境Id
70+
TENCENT_SECRET_KEY=腾讯云 SecretKey
71+
TENCENT_SECRET_ID=腾讯云 SecretId
72+
```
73+
74+
`SecretKey``SecretId` 的获取参考 <https://cloud.tencent.com/developer/article/1385239>
75+
76+
用 vscode 打开 `lavcode-node` 目录,按 F5 即可启动调试
77+
78+
或执行命令 `npm start`
79+
80+
## 安全性
81+
82+
云接口使用 [jwt](https://jwt.io/) 来保证接口不会被非法调用
83+
84+
## 开发接口
85+
86+
你也可以参考源码 `lavcode-node` 自己开发后端接口,能更灵活的更换语言框架和数据库
60.4 KB
Loading
43 KB
Loading
59.4 KB
Loading
59.2 KB
Loading
39.8 KB
Loading
-220 KB
Loading

0 commit comments

Comments
 (0)