Browse Source

Update doc according to recent update of Spring / Swagger (#11755)

3.1.0-release
kezhenxu94 2 years ago committed by GitHub
parent
commit
31ba49ac02
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 2
      docs/docs/en/contribute/development-environment-setup.md
  2. 6
      docs/docs/en/faq.md
  3. 5
      docs/docs/en/guide/open-api.md
  4. 2
      docs/docs/zh/contribute/development-environment-setup.md
  5. 4
      docs/docs/zh/faq.md
  6. 4
      docs/docs/zh/guide/open-api.md

2
docs/docs/en/contribute/development-environment-setup.md

@ -206,7 +206,7 @@ There are three services that need to be started, including MasterServer, Worker
* MasterServer:Execute function `main` in the class `org.apache.dolphinscheduler.server.master.MasterServer` by Intellij IDEA, with the configuration *VM Options* `-Dlogging.config=classpath:logback-spring.xml -Ddruid.mysql.usePingMethod=false -Dspring.profiles.active=mysql`
* WorkerServer:Execute function `main` in the class `org.apache.dolphinscheduler.server.worker.WorkerServer` by Intellij IDEA, with the configuration *VM Options* `-Dlogging.config=classpath:logback-spring.xml -Ddruid.mysql.usePingMethod=false -Dspring.profiles.active=mysql`
* ApiApplicationServer:Execute function `main` in the class `org.apache.dolphinscheduler.api.ApiApplicationServer` by Intellij IDEA, with the configuration *VM Options* `-Dlogging.config=classpath:logback-spring.xml -Dspring.profiles.active=api,mysql`. After it started, you could find Open API documentation in http://localhost:12345/dolphinscheduler/doc.html
* ApiApplicationServer:Execute function `main` in the class `org.apache.dolphinscheduler.api.ApiApplicationServer` by Intellij IDEA, with the configuration *VM Options* `-Dlogging.config=classpath:logback-spring.xml -Dspring.profiles.active=api,mysql`. After it started, you could find Open API documentation in http://localhost:12345/dolphinscheduler/swagger-ui/index.html
> The `mysql` in the VM Options `-Dspring.profiles.active=mysql` means specified configuration file

6
docs/docs/en/faq.md

@ -533,7 +533,8 @@ A: 1, We can successly create scheduled task and add one record into t_scheduler
## Q : What is the address of swagger ui
A: 1, For version 1.2+ is http://apiServerIp:apiServerPort/dolphinscheduler/doc.html others is http://apiServerIp:apiServerPort/escheduler/doc.html.
A: 1, For version 3.1.0+ is http://apiServerIp:apiServerPort/dolphinscheduler/swagger-ui/index.html,
for version 1.2+ is http://apiServerIp:apiServerPort/dolphinscheduler/doc.html others is http://apiServerIp:apiServerPort/escheduler/doc.html.
---
@ -582,7 +583,7 @@ A: 1, It is currently judged according to natural days, at the end of last month
## Q : DS Backend Inteface Document
A: 1, http://106.75.43.194:8888/dolphinscheduler/doc.html?language=en.
A: 1, http://106.75.43.194:8888/dolphinscheduler/swagger-ui/index.html?language=en.
## During the operation of dolphinscheduler, the ip address is obtained incorrectly
@ -752,4 +753,3 @@ start API server. If you want disabled when Python gateway service you could cha
---
We will collect more FAQ later

5
docs/docs/en/guide/open-api.md

@ -22,7 +22,7 @@ Generally, projects and processes are created through pages, but considering the
1. Open the API documentation
> Address:http://{API server ip}:12345/dolphinscheduler/doc.html?language=en_US&lang=en
> Address:http://{API server ip}:12345/dolphinscheduler/swagger-ui/index.html?language=en_US&lang=en
![api-doc](../../../img/new_ui/dev/open-api/api_doc.png)
@ -63,6 +63,3 @@ If you are interested in the source code of creating a project, please continue
![api-source01](../../../img/new_ui/dev/open-api/api_source01.png)
![api-source02](../../../img/new_ui/dev/open-api/api_source02.png)

2
docs/docs/zh/contribute/development-environment-setup.md

@ -197,7 +197,7 @@ DolphinScheduler 的元数据存储在关系型数据库中,目前支持的关
* MasterServer:在 Intellij IDEA 中执行 `org.apache.dolphinscheduler.server.master.MasterServer` 中的 `main` 方法,并配置 *VM Options* `-Dlogging.config=classpath:logback-spring.xml -Ddruid.mysql.usePingMethod=false -Dspring.profiles.active=mysql`
* WorkerServer:在 Intellij IDEA 中执行 `org.apache.dolphinscheduler.server.worker.WorkerServer` 中的 `main` 方法,并配置 *VM Options* `-Dlogging.config=classpath:logback-spring.xml -Ddruid.mysql.usePingMethod=false -Dspring.profiles.active=mysql`
* ApiApplicationServer:在 Intellij IDEA 中执行 `org.apache.dolphinscheduler.api.ApiApplicationServer` 中的 `main` 方法,并配置 *VM Options* `-Dlogging.config=classpath:logback-spring.xml -Dspring.profiles.active=api,mysql`。启动完成可以浏览 Open API 文档,地址为 http://localhost:12345/dolphinscheduler/doc.html
* ApiApplicationServer:在 Intellij IDEA 中执行 `org.apache.dolphinscheduler.api.ApiApplicationServer` 中的 `main` 方法,并配置 *VM Options* `-Dlogging.config=classpath:logback-spring.xml -Dspring.profiles.active=api,mysql`。启动完成可以浏览 Open API 文档,地址为 http://localhost:12345/dolphinscheduler/swagger-ui/index.html
> VM Options `-Dspring.profiles.active=mysql``mysql` 表示指定的配置文件

4
docs/docs/zh/faq.md

@ -488,7 +488,7 @@ A:1,我们可以成功创建调度任务,并且表 t_scheduler_schedules
---
## Q:请问 swagger ui 的地址是什么
A:1,1.2+ 版本地址是:http://apiServerIp:apiServerPort/dolphinscheduler/doc.html?language=zh_CN&lang=cn,其它版本是 http://apiServerIp:apiServerPort/escheduler/doc.html?language=zh_CN&lang=cn。
A:1, 3.1.0+ 版本地址是 http://apiServerIp:apiServerPort/dolphinscheduler/swagger-ui/index.html, 1.2+ 版本地址是:http://apiServerIp:apiServerPort/dolphinscheduler/swagger-ui/index.html?language=zh_CN&lang=cn,其它版本是 http://apiServerIp:apiServerPort/escheduler/swagger-ui/index.html?language=zh_CN&lang=cn。
---
@ -529,7 +529,7 @@ A:1,目前是按照自然天来判断,上月末:判断时间是工作流
---
## Q:DS 后端接口文档
A:1,http://106.75.43.194:8888/dolphinscheduler/doc.html?language=zh_CN&lang=zh。
A:1,http://106.75.43.194:8888/dolphinscheduler/swagger-ui/index.html?language=zh_CN&lang=zh。
## dolphinscheduler 在运行过程中,ip 地址获取错误的问题

4
docs/docs/zh/guide/open-api.md

@ -22,7 +22,7 @@
1. 打开 API 文档页面
> 地址:http://{api server ip}:12345/dolphinscheduler/doc.html?language=zh_CN&lang=cn
> 地址:http://{api server ip}:12345/dolphinscheduler/swagger-ui/index.html?language=zh_CN&lang=cn
![api-doc](../../../img/new_ui/dev/open-api/api_doc.png)
@ -63,5 +63,3 @@
![api-source01](../../../img/new_ui/dev/open-api/api_source01.png)
![api-source02](../../../img/new_ui/dev/open-api/api_source02.png)

Loading…
Cancel
Save