Skip to content

Commit 848377e

Browse files
authored
add krakend docs
1 parent 4a790cc commit 848377e

File tree

2 files changed

+46
-41
lines changed
  • i18n/en/docusaurus-plugin-content-docs/version-2.0/apps
  • versioned_docs/version-2.0/apps

2 files changed

+46
-41
lines changed

i18n/en/docusaurus-plugin-content-docs/version-2.0/apps/krakend.md

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22
title: KrakenD
33
slug: /krakend
44
tags:
5-
- console
6-
- other
5+
- Unified Gateway
6+
- API Gateway
7+
- KrakenD
78
---
89

910
import Meta from './_include/krakend.md';
@@ -12,32 +13,34 @@ import Meta from './_include/krakend.md';
1213

1314
## Getting started{#guide}
1415

15-
### Initial setup{#wizard}
16-
17-
1. When completed installation of KrakenD at **Websoft9 Console**, get the applicaiton's **Overview** and **Access** information from **My Apps**
18-
19-
2. Complete the install wizard step by step
20-
2116
### Login verification{#verification}
2217

2318
1. Completed installation KrakenD at Websoft9 console, get the applicaiton's overview and access credentials from **My Apps**
2419

2520
2. Starting to verify it
2621

27-
## Configuration options{#configs}
22+
### Add Upstream API
2823

29-
- CLI
30-
- Multilingual (√)
31-
- SMTP (√)
24+
1. [Arrange the KrakenD application](https://support.websoft9.com/docs/app-compose#dynamic), adding an entry to the endpoints array in `src/krakend.json` as follows:
3225

33-
## Administer{#administrator}
26+
```
27+
{
28+
“endpoint”: “/api/users”,
29+
“method”: “GET”,
30+
“timeout”: “5000ms”,
31+
{
32+
“url_pattern”: “/api/users”,
33+
“host”: [“http://localhost:9000”],
34+
“method”: “GET”
35+
}
36+
]
37+
}
38+
```
39+
40+
2. After rebuilding the application, you can access the upstream API via the unified path.
3441

35-
- **Password recover**
36-
- **Change URL**
37-
- **HTTPS**
38-
- **Online backup**
39-
- **Online upgrade**
42+
## Configuration options{#configs}
4043

41-
## Troubleshooting{#troubleshooting}
44+
## Administer{#administrator}
4245

43-
#### 502 failed code?
46+
## Troubleshooting{#troubleshooting}

versioned_docs/version-2.0/apps/krakend.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,42 +2,44 @@
22
title: KrakenD
33
slug: /krakend
44
tags:
5-
- Web 面板
6-
- 可视化
7-
- GUI
5+
- 统一网关
6+
- API 网关
7+
- KrakenD
88
---
99

1010
import Meta from './_include/krakend.md';
1111

1212
<Meta name="meta" />
1313

14-
## 入门指南{#guide}
14+
## 入门指南{#guide}
1515

16-
### 初始化{#wizard}
16+
### 登录后台{#console}
1717

1818
Websoft9 控制台安装 KrakenD 后,通过 **我的应用** 查看应用详情,在 **访问** 标签页中获取登录信息。
1919

20-
### 登录后台{#console}
20+
### 添加上游 API
2121

22-
Websoft9 控制台安装 KrakenD 后,通过 **我的应用** 查看应用详情,在 **访问** 标签页中获取登录信息。
22+
1. [编排 KrakenD 应用](https://support.websoft9.com/docs/app-compose#dynamic),将 `src/krakend.json` 的 endpoints数组增加一项,如下
2323

24-
### 安装插件{#plugin}
24+
```
25+
{
26+
"endpoint": "/api/users",
27+
"method": "GET",
28+
"timeout": "5000ms",
29+
{
30+
"url_pattern": "/api/users",
31+
"host": ["http://localhost:9000"],
32+
"method": "GET"
33+
}
34+
]
35+
}
36+
```
2537

26-
## 配置选项{#configs}
38+
2. 重建应用后即可通过统一路径访问上游API
2739

28-
- CLI
29-
- 多语言(√)
30-
- SMTP(√)
31-
- 插件市场(√)
3240

33-
## 管理维护{#administrator}
41+
## 配置选项{#configs}
3442

35-
- **重置管理员密码**
36-
- **更换 URL**
37-
- **HTTPS 额外设置**
38-
- **在线备份**
39-
- **在线升级**
43+
## 管理维护{#administrator}
4044

4145
## 故障
42-
43-
#### 更改域名导致无法访问 ?

0 commit comments

Comments
 (0)