This is an automated email from the ASF dual-hosted git repository.
lidongdai pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/incubator-dolphinscheduler-website.git
The following commit(s) were added to refs/heads/master by this push:
new 87862e3 add open-api.md (#316)
87862e3 is described below
commit 87862e34659baf745ca91739962a1c5d7c64b0eb
Author: aaronlinv <[email protected]>
AuthorDate: Thu Apr 8 23:37:13 2021 +0800
add open-api.md (#316)
* add open-api.md
* Update open-api.md
* Update open-api.md
* Update open-api.md
Co-authored-by: dailidong <[email protected]>
---
docs/en-us/1.3.5/user_doc/open-api.md | 38 ++++++++++++++++++++++++++++++++++
docs/zh-cn/1.3.5/user_doc/open-api.md | 38 ++++++++++++++++++++++++++++++++++
img/api-documentation-en.png | Bin 0 -> 77247 bytes
img/api-documentation.png | Bin 0 -> 61869 bytes
img/create-token-en1.png | Bin 0 -> 8779 bytes
img/create-token.png | Bin 0 -> 7699 bytes
img/test-api.png | Bin 0 -> 40028 bytes
img/token-management-en.png | Bin 0 -> 35282 bytes
img/token-management.png | Bin 0 -> 34871 bytes
site_config/docs1-3-5.js | 7 +++++++
10 files changed, 83 insertions(+)
diff --git a/docs/en-us/1.3.5/user_doc/open-api.md
b/docs/en-us/1.3.5/user_doc/open-api.md
new file mode 100644
index 0000000..724d2c2
--- /dev/null
+++ b/docs/en-us/1.3.5/user_doc/open-api.md
@@ -0,0 +1,38 @@
+
+# Open API
+
+## Background
+Generally, projects and processes are created through pages, but integration
with third-party systems requires API calls to manage projects and workflows.
+
+## Operating steps
+
+### Create token
+1. Log in to the scheduling system, click "Security", then click "Token
manage" on the left, and click "Create token" to create a token.
+
+<p align="center">
+ <img src="/img/token-management-en.png" width="80%" />
+ </p>
+
+2. Select the "Expiration time" (Token validity), select "User" (to perform
the API operation with the specified user), click "Generate token", copy the
Token string, and click "Submit"
+
+<p align="center">
+ <img src="/img/create-token-en1.png" width="80%" />
+ </p>
+
+### Use token
+1. Open the API documentation page
+ > Address：http://{api server
ip}:12345/dolphinscheduler/doc.html?language=en_US&lang=en
+<p align="center">
+ <img src="/img/api-documentation-en.png" width="80%" />
+ </p>
+
+2. select a test API, the API selected for this test: queryAllProjectList
+ > projects/query-project-list
+ >
+3. Open Postman, fill in the API address, and enter the Token in Headers, and
then send the request to view the result
+ ```
+ token:The Token just generated
+ ```
+<p align="center">
+ <img src="/img/test-api.png" width="80%" />
+ </p>
diff --git a/docs/zh-cn/1.3.5/user_doc/open-api.md
b/docs/zh-cn/1.3.5/user_doc/open-api.md
new file mode 100644
index 0000000..564bfc3
--- /dev/null
+++ b/docs/zh-cn/1.3.5/user_doc/open-api.md
@@ -0,0 +1,38 @@
+
+# API 调用
+
+## 背景
+一般都是通过页面来创建项目、流程等，但是与第三方系统集成就需要通过调用 API 来管理项目、流程
+
+## 操作步骤
+
+### 创建token
+
+1. 登录调度系统，点击 "安全中心"，再点击左侧的 "令牌管理"，点击 "令牌管理" 创建令牌
+
+<p align="center">
+ <img src="/img/token-management.png" width="80%" />
+ </p>
+
+2. 选择 "失效时间" (Token有效期)，选择 "用户" (以指定的用户执行接口操作)，点击 "生成令牌" ，拷贝 Token 字符串，然后点击
"提交"
+<p align="center">
+ <img src="/img/create-token.png" width="80%" />
+ </p>
+
+### 使用 Token
+1. 打开 API文档页面
+ > 地址：http://{api server
ip}:12345/dolphinscheduler/doc.html?language=zh_CN&lang=cn
+<p align="center">
+ <img src="/img/api-documentation.png" width="80%" />
+ </p>
+
+2. 选一个测试的接口，本次测试选取的接口是：查询所有项目
+ > projects/query-project-list
+
+3. 打开 Postman，填写接口地址，并在 Headers 中填写 Token，发送请求后即可查看结果
+ ```
+ token:刚刚生成的Token
+ ```
+<p align="center">
+ <img src="/img/test-api.png" width="80%" />
+ </p>
diff --git a/img/api-documentation-en.png b/img/api-documentation-en.png
new file mode 100644
index 0000000..81f6b78
Binary files /dev/null and b/img/api-documentation-en.png differ
diff --git a/img/api-documentation.png b/img/api-documentation.png
new file mode 100644
index 0000000..97dc027
Binary files /dev/null and b/img/api-documentation.png differ
diff --git a/img/create-token-en1.png b/img/create-token-en1.png
new file mode 100644
index 0000000..7542464
Binary files /dev/null and b/img/create-token-en1.png differ
diff --git a/img/create-token.png b/img/create-token.png
new file mode 100644
index 0000000..987a591
Binary files /dev/null and b/img/create-token.png differ
diff --git a/img/test-api.png b/img/test-api.png
new file mode 100644
index 0000000..71ae6f4
Binary files /dev/null and b/img/test-api.png differ
diff --git a/img/token-management-en.png b/img/token-management-en.png
new file mode 100644
index 0000000..6d31e5f
Binary files /dev/null and b/img/token-management-en.png differ
diff --git a/img/token-management.png b/img/token-management.png
new file mode 100644
index 0000000..d3de6a9
Binary files /dev/null and b/img/token-management.png differ
diff --git a/site_config/docs1-3-5.js b/site_config/docs1-3-5.js
index 754eca3..9573ebb 100644
--- a/site_config/docs1-3-5.js
+++ b/site_config/docs1-3-5.js
@@ -48,6 +48,9 @@ export default {
{
title: 'Task Structure',
link: '/en-us/docs/1.3.5/user_doc/task-structure.html',
+ }, {
+ title: 'Open API',
+ link: '/en-us/docs/1.3.5/user_doc/open-api.html',
},
],
},
@@ -110,6 +113,10 @@ export default {
title: '用户手册',
link: '/zh-cn/docs/1.3.5/user_doc/system-manual.html',
},
+ {
+ title: 'API调用',
+ link: '/zh-cn/docs/1.3.5/user_doc/open-api.html',
+ },
],
},
