This is an automated email from the ASF dual-hosted git repository.
xiaoyu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/shenyu-website.git
The following commit(s) were added to refs/heads/main by this push:
new 63dd2b3bf7 [ISSUE #943]Add usage documentation: how to register
apidoc. (#947)
63dd2b3bf7 is described below
commit 63dd2b3bf74823694430e0e159e4354e567b04d8
Author: lianjunwei <[email protected]>
AuthorDate: Fri Aug 11 14:07:32 2023 +0800
[ISSUE #943]Add usage documentation: how to register apidoc. (#947)
* APIDOC
* apidoc img.
* apidoc img.
* apidoc
* Chinese apidoc document
* apidoc document
* commit
* fix code style.
---------
Co-authored-by: lianjunwei <[email protected]>
---
docs/user-guide/admin-usage/api-document.md | 73 ++++++++++++++------
docs/user-guide/api-doc/_category_.json | 4 ++
.../shenyu-annotation-apidoc.md} | 0
docs/user-guide/api-doc/swagger-apidoc.md | 57 ++++++++++++++++
.../current/user-guide/admin-usage/api-document.md | 76 ++++++++++++++-------
.../current/user-guide/api-doc/_category_.json | 4 ++
.../shenyu-annotation-apidoc.md} | 4 +-
.../current/user-guide/api-doc/swagger-apidoc.md | 57 ++++++++++++++++
static/img/shenyu/api-doc/apidoc-detail-cn.png | Bin 0 -> 559074 bytes
static/img/shenyu/api-doc/apidoc-detail-en.png | Bin 0 -> 579537 bytes
static/img/shenyu/api-doc/apidoc-dictionary-cn.png | Bin 0 -> 404563 bytes
static/img/shenyu/api-doc/apidoc-dictionary-en.png | Bin 0 -> 396747 bytes
.../img/shenyu/api-doc/apidoc-swagger-list-cn.png | Bin 0 -> 828385 bytes
.../img/shenyu/api-doc/apidoc-swagger-list-en.png | Bin 0 -> 825948 bytes
.../shenyu/api-doc/app-proxy-startuptime-cn.png | Bin 0 -> 157752 bytes
.../shenyu/api-doc/app-proxy-startuptime-en.png | Bin 0 -> 524034 bytes
.../apiManagement/api-published-divide-list-cn.png | Bin 0 -> 330648 bytes
.../apiManagement/api-published-divide-list-en.png | Bin 0 -> 350594 bytes
.../basicConfig/apiManagement/apidoc-env-cn.png | Bin 0 -> 402204 bytes
.../basicConfig/apiManagement/apidoc-env-en.png | Bin 0 -> 396025 bytes
.../basicConfig/apiManagement/app-create-cn.png | Bin 0 -> 288326 bytes
.../basicConfig/apiManagement/app-create-en.png | Bin 0 -> 373096 bytes
.../basicConfig/apiManagement/create-api-cn.png | Bin 795340 -> 494020 bytes
.../basicConfig/apiManagement/create-api-en.png | Bin 742476 -> 492508 bytes
.../basicConfig/apiManagement/create-tag-1-cn.png | Bin 388937 -> 0 bytes
.../basicConfig/apiManagement/create-tag-1-en.png | Bin 392572 -> 0 bytes
.../basicConfig/apiManagement/create-tag-2-cn.png | Bin 386080 -> 0 bytes
.../basicConfig/apiManagement/create-tag-2-en.png | Bin 316885 -> 0 bytes
.../basicConfig/apiManagement/publish-api-cn.png | Bin 1276715 -> 605490
bytes
.../basicConfig/apiManagement/publish-api-en.png | Bin 341189 -> 604072 bytes
30 files changed, 228 insertions(+), 47 deletions(-)
diff --git a/docs/user-guide/admin-usage/api-document.md
b/docs/user-guide/admin-usage/api-document.md
index b5bcf81862..8fc5dee3a9 100644
--- a/docs/user-guide/admin-usage/api-document.md
+++ b/docs/user-guide/admin-usage/api-document.md
@@ -1,10 +1,10 @@
---
title: API Document Management
-keywords: ["api doc"]
+keywords: ["api doc Document"]
description: API document management
---
-## Design Notes
+## 1. Design Notes
When the front and back end are jointly debugged, it is usually necessary for
the back end to give documents to detail the input and output of the interface;
@@ -12,46 +12,75 @@ After the backend development is complete, you need to test
whether the access g
In order to reduce the sense of fragmentation and improve the user experience
of front-end and back-end development, it is necessary to see the API
documentation in shenyu-admin and test the API directly.
-## How to use
+## 2. How to use
The brief introduce is as follows.
-- Back-end development produces API documents in shenyu-admin (both `manual`
and `client registration` are supported, and `client registration` is currently
recommended).
+- Back-end development produces API documents in shenyu-admin.
+> Three methods of `remotely pulling swagger`, `manual filling`, and `client
registration` are already supported. From the perspective of functional
integrity and user experience, `remotely pulling swagger` is currently
recommended, and the latter two methods will be in Continuous function
enhancement in later versions.
- The frontend looks at the API documentation in shenyu-admin and starts
development.
> During joint debugging, developers (including front-end and backend) may use
> the testing function in shenyu-admin to request APIs directly.
-Now, let's look how to operation step by step:
+## 3. Set the global environment address
-### Add API Document Manually
+In actual use, you may have multiple gateway addresses (such as production
environment, test environment, or public network environment, intranet
environment), you can manage them in `Apache ShenYu` Gateway Management System
--> BasicConfig --> Dictionary, Set multiple gateway addresses.
-Clicking the menu "Document -> API Document" to create tag and api.
+
-> For the API registration documentation through the client, please refer to
[Client Registration API Documentation](../api-document-register.md)
+> DictionaryType: Fill in the value must be `apidocEnv`;
+>
+> DictionaryCode: The identifier of the gateway address has no actual meaning.
It is recommended to use `ENV_LABEL_` as a prefix, such as `ENV_LABEL_OFFLINE`;
+>
+> DictionaryName: Indicates the gateway type, such as filling in `test
environment`, `production environment`. This value will appear on the API
documentation details page;
+>
+> DictionaryValue: Indicates the gateway address, such as
http://127.0.0.1:9195. This value will appear on the API documentation details
page;
+>
+> DictionaryDescribe: Give a brief description of what scenario the gateway
address is used for. This value will appear on the API documentation details
page;
+>
+> Sort: The numerical value determines the display order of the gateway
address;
+>
+> Status: open or close。
-#### Add tag
+## 4. Support Multiple Ways to Aggregate API Documents
-Tags are used to classify API documents, and you can hang both APIs and tags
under the tags, and there is no hierarchical limit.
-<img src="/img/shenyu/basicConfig/apiManagement/create-tag-1-en.png"
width="80%" height="50%" />
+### 4.1 Add API Document Manually
-<img src="/img/shenyu/basicConfig/apiManagement/create-tag-2-en.png"
width="80%" height="50%" />
+Clicking the menu "Document -> API Document" to create api.
-#### Add API Document
+##### Create Project
-<img src="/img/shenyu/basicConfig/apiManagement/create-api-en.png" width="80%"
height="50%" />
+If you have not created a project or you want to classify the new API into a
new project, you need to create a project.
-The list here is the API documentation we're adding.
+
-#### Publish API
+##### Add API Documentation
+
+
+
+### 4.2 Remotely pull the swagger registration API Document.
+
+Automatically register API documentation by remotely pulling swager
documentation. Please refer to [Remote pull swagger registration API
document](../api-doc/swagger-apidoc.md)
+
+### 4.3 Shenyu Client Annotation Registration API Documentation
+
+Automatically register API documents through Shenyu client annotations. Please
refer to [Client Registration API
Documentation](../api-doc/shenyu-annotation-apidoc.md)
+> This method is recommended if you do not expect to view the full interface
documentation details. When you choose this automatic registration method,
please turn off the registration method of remote automatic pull swagger,
otherwise there will be conflicts.
+
+## 5. Publish API
If the API has never been published and the user has not used the
shenyu-client, shenyu-admin will automatically expose the API described in the
API document to the gateway.
-<img src="/img/shenyu/basicConfig/apiManagement/publish-api-en.png"
width="80%" height="50%" />
+
+
+After clicking Save, you'll see that the registration data for the API is
inserted below the selectors and rules. As shown below:
+
+
-#### Offline API(optional)
+## 6. Offline API(optional)
-> Notice: After clicking offline, the API document will still be visible, but
the interface exposed to the gateway will immediately become invalid.
+> Special Note: After clicking Offline, the API will still be visible in the
API document list, but it will be deleted from the proxy plug-in and metadata
management list. Before you republish the API, the gateway will not proxy the
API. When you pass through the gateway When requesting this API, an exception
will be reported.
-<img src="/img/shenyu/basicConfig/apiManagement/offline-api-en.png"
width="80%" height="50%" />
+
-### API Debug
+## 7. API Debug
-<img src="/img/shenyu/basicConfig/apiManagement/api-debug-en.png" width="80%"
height="50%" />
+
diff --git a/docs/user-guide/api-doc/_category_.json
b/docs/user-guide/api-doc/_category_.json
new file mode 100644
index 0000000000..ae4f3bab40
--- /dev/null
+++ b/docs/user-guide/api-doc/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "API Document Aggregation",
+ "position": 6
+}
diff --git a/docs/user-guide/api-document-register.md
b/docs/user-guide/api-doc/shenyu-annotation-apidoc.md
similarity index 100%
rename from docs/user-guide/api-document-register.md
rename to docs/user-guide/api-doc/shenyu-annotation-apidoc.md
diff --git a/docs/user-guide/api-doc/swagger-apidoc.md
b/docs/user-guide/api-doc/swagger-apidoc.md
new file mode 100644
index 0000000000..2c9d17a0ef
--- /dev/null
+++ b/docs/user-guide/api-doc/swagger-apidoc.md
@@ -0,0 +1,57 @@
+---
+title: Pull the swagger registration API document
+keywords: ["swagger api Interface Document Aggregation"]
+description: Remotely pull swagger registration API documentation
+---
+
+This article introduces how to aggregate the `Swagger API documentation` of
each backend microservice to the `Apache ShenYu` gateway management system.
+
+## 1. Description
+
+Remotely pull swagger documents, currently only supports swagger2.0, and only
supports Divide and SpringCloud proxy plug-ins.
+
+## 2. Environment Preparation
+
+### 2.1 Run `shenyu-admin`
+
+Please refer to the `deployment` document, choose a way to run `shenyu-admin`.
+
+### 2.2 Enable the global switch for remotely pulling swagger documents.
+
+It is enabled by default. In the `Apache ShenYu` gateway management system -->
BasicConfig --> Dictionary, find the data whose DictionaryType is `apidoc`, and
modify the dictionary value: `true`.
+> 【Notice】DictionaryValue: `true` means the switch is on, `false` means it is
off. If it is closed, `shenyu-admin` will not automatically pull the swagger
documents of each microservice.
+
+
+
+## 3. Run the Sample Project
+
+3.1. Download
[shenyu-examples-http-swagger2](https://github.com/apache/shenyu/tree/master/shenyu-examples/shenyu-examples-http-swagger2)
+
+3.2. Run `org.apache.shenyu.examples.http.ShenyuTestSwaggerApplication` main
method to start the project.
+
+The examples project will synchronize the service startup information to
`shenyu-admin` through the Shenyu client annotation (such as
`@ShenyuSpringMvcClient`) according to the address configured by
`shenyu.register.serverLists`, and then trigger `shenyu-admin` to remotely pull
the swagger document And complete the analysis, and finally aggregate to
produce a new API document.
+
+## 4. Demonstration Effect
+
+### 4.1 List of API Documents
+
+In `Apache ShenYu` Gateway Management System --> Document --> API Document,
you can see the aggregated API documents.
+
+
+
+### 4.2 API Details Effect
+
+
+
+## 5. How to Automatically Update API Documentation
+
+### 5.1 Restart Project
+
+As in the example above, an automatic update of the API docs is triggered by
starting the project.
+
+### 5.2 Modify the startup time of the proxy plugin selector.
+
+In the PlugiList --> Proxy --> selector, find the target service, and then
modify the startup time.
+> Note: The startup time of the new setting must not be earlier than the
original startup time, otherwise the API document will not be automatically
pulled and refreshed.
+
+
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/admin-usage/api-document.md
b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/admin-usage/api-document.md
index df5ec51128..b0a9114f35 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/admin-usage/api-document.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/admin-usage/api-document.md
@@ -4,7 +4,7 @@ keywords: ["api doc 接口 文档"]
description: API文档管理
---
-## 背景与说明
+## 1. 背景与说明
前后端联调时，通常需要后端给出文档以详细说明接口的输入输出；
@@ -12,45 +12,75 @@ description: API文档管理
为了减少割裂感、提升前后端开发的用户体验，需要在shenyu-admin中看到API文档，以及直接对API进行测试。
-## 操作流程
+## 2. 使用流程
大体的流程如下：
-- 后端开发在shenyu-admin中产出API文档(同时支持`手动填写`和`客户端注册`2种方式，目前更推荐`客户端注册`)。
+- 后端开发在shenyu-admin中产出API文档。
+>
已经支持`远程拉取swagger`、`手动填写`、`客户端注册`3种方式。从功能完整性和使用体验上，目前更推荐`远程拉取swagger`，后2种方式将会在后面版本持续功能增强。
- 前端在shenyu-admin中查看API文档并开始开发。
-> 联调期间开发人员(包括前后端)可能使用shenyu-admin中的测试功能直接请求API。
+> 联调期间开发人员(包括前后端)可以直接使用shenyu-admin中的接口调试功能发起API调用。
-接下来我们看下具体操作：
+## 3. 设置全局的环境地址
-### 手动填写API文档
+实际使用中，可能你有多个网关地址（比如生产环境、测试环境，或者公网环境、内网环境），你可以在`Apache ShenYu`网关管理系统 --> 基础配置
--> 字典管理，配置多个网关地址。
-在点击菜单 "文档 -> API文档" 展示的页面中新增数据。
+
-> 通过客户端注册API文档请参考[客户端注册API文档](../api-document-register.md)
+> 字典类型：填写值必须是`apidocEnv`；
+>
+> 字典编码：网关地址的编码标识，无实际含义，建议以 `ENV_LABEL_`作为前缀，比如 `ENV_LABEL_OFFLINE`；
+>
+> 字典名称：表示网关类型，比如填写 `测试环境`、`生产环境`。该值将会出现在API文档详情页面；
+>
+> 字典值：表示网关地址，比如 http://127.0.0.1:9195。该值将会出现在API文档详情页面；
+>
+> 字典描述或备注：该网关地址用于何种场景，做一个简短描述。该值将会出现在API文档详情页面；
+>
+> 排序：数值大小决定了网关地址的展示顺序；
+>
+> 状态：打开或关闭。
-#### 增加标签
+## 4. 支持多种方式聚合API文档
-标签用于给API文档分类，标签下面既可以挂API，也可以挂标签，没有层级限制。
-<img src="/img/shenyu/basicConfig/apiManagement/create-tag-1-cn.png"
width="80%" height="50%" />
+### 4.1 手动填写API文档
-<img src="/img/shenyu/basicConfig/apiManagement/create-tag-2-cn.png"
width="80%" height="50%" />
+点击菜单 "文档 -> API文档", 展示的页面中新增数据。
-#### 增加API文档
+##### 创建项目
-<img src="/img/shenyu/basicConfig/apiManagement/create-api-cn.png" width="80%"
height="50%" />
+如果你还没有创建过项目或者你要把新建的API归类到新项目，这时需要你创建一个项目。
-这里出现列表的就是我们正在新增的API文档。
+
-#### 发布API
+##### 增加API文档
-如果该API是从未发布到发布且用户并未接入shenyu客户端，shenyu-admin将会自动把API文档所描述的API暴露到网关。
-<img src="/img/shenyu/basicConfig/apiManagement/publish-api-cn.png"
width="80%" height="50%" />
+
-#### 下线API(可选)
+### 4.2 远程拉取swagger注册API文档
-> 特别注意：点击下线后，API文档仍然可见，但暴露到网关的接口将会立即失效。
+ 通过远程拉取swaager文档自动注册API文档。请参考[远程拉取swagger注册API文档](../api-doc/swagger-apidoc.md)
-<img src="/img/shenyu/basicConfig/apiManagement/offline-api-cn.png"
width="80%" height="50%" />
+### 4.3 Shenyu客户端注解注册API文档
-### 请求API
+ 通过Shenyu客户端注解自动注册API文档。请参考[客户端注册API文档](../api-doc/shenyu-annotation-apidoc.md)
+> 若你没有查看完整接口文档详情的诉求，推荐使用这此方式。当你选择了这种自动注册方式，请关闭远程自动拉取swagger的注册方式，否则会有冲突。
-<img src="/img/shenyu/basicConfig/apiManagement/api-debug-cn.png" width="80%"
height="50%" />
+## 5. 发布API
+
+如果该API从未发布到proxy插件或你不打算使用shenyu客户端提供的注解注册URI，shenyu-admin的发布API功能为你提供了另一种可选方式，它将自动注册该API到网关，跟你使用shenyu客户端的注解效果一样。
+
+
+
+点击保存后，你会看到，在选择器和规则下面插入了该API的注册数据。如下图所示：
+
+
+
+## 6. 下线API(可选)
+
+>
特别注意：点击下线后，该API虽然在API文档列表仍然可见，但会从proxy插件和元数据管理列表中删除，在你重新发布该API前，网关不会代理该API，当你通过网关请求该API时，会报异常。
+
+
+
+## 7. 请求API（接口调试）
+
+
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/api-doc/_category_.json
b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/api-doc/_category_.json
new file mode 100644
index 0000000000..8934b1125d
--- /dev/null
+++
b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/api-doc/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "API文档聚合",
+ "position": 6
+}
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/api-document-register.md
b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/api-doc/shenyu-annotation-apidoc.md
similarity index 92%
rename from
i18n/zh/docusaurus-plugin-content-docs/current/user-guide/api-document-register.md
rename to
i18n/zh/docusaurus-plugin-content-docs/current/user-guide/api-doc/shenyu-annotation-apidoc.md
index d2d1c0f1cf..0a41e4475f 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/api-document-register.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/api-doc/shenyu-annotation-apidoc.md
@@ -1,7 +1,7 @@
---
-title: 客户端注册API文档
+title: Shenyu客户端注册API文档
keywords: ["api doc 接口 文档 register 注册"]
-description: 客户端注册API文档
+description: Shenyu客户端注册API文档
---
此篇文介绍如何将 `API文档` 暴露到 `Apache ShenYu` 网关。
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/api-doc/swagger-apidoc.md
b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/api-doc/swagger-apidoc.md
new file mode 100644
index 0000000000..f9ca7b5a6f
--- /dev/null
+++
b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/api-doc/swagger-apidoc.md
@@ -0,0 +1,57 @@
+---
+title: 拉取swagger注册API文档
+keywords: ["swagger api 接口 文档聚合"]
+description: 远程拉取swagger 注册 API文档
+---
+
+此篇文介绍如何将各个后端微服务的 `Swagger API文档` 聚合到 `Apache ShenYu` 网关管理系统。
+
+## 1. 说明
+
+远程拉取swagger文档，目前仅支持swaggger2.0，并且只支持 Divide 和 SpringCloud 两种代理插件。
+
+## 2. 环境准备
+
+### 2.1 启动`shenyu-admin`
+
+参考 `运维部署` , 选择一种方式启动`shenyu-admin`。
+
+### 2.2 开启远程拉取swagger文档的全局开关
+
+默认已开启。在`Apache ShenYu`网关管理系统 --> 基础配置 --> 字典管理， 找到字典编码为 `apidoc`的数据，修改 字典值:
`true`。
+> 【注意】字典值：`true`表示开关已开启，`false`表示已关闭。若关闭后，`shenyu-admin`不会自动拉取各个微服务的swaggger文档。
+
+
+
+## 3. 运行示例项目
+
+3.1. 下载
[shenyu-examples-http-swagger2](https://github.com/apache/shenyu/tree/master/shenyu-examples/shenyu-examples-http-swagger2)
+
+3.2. 运行`org.apache.shenyu.examples.http.ShenyuTestSwaggerApplication`
main方法启动项目。
+
+examples项目会根据 `shenyu.register.serverLists` 配置的地址，通过 Shenyu client
注解(比如`@ShenyuSpringMvcClient`) 将服务启动信息同步给 `shenyu-admin`, 然后触发 `shenyu-admin`
远程拉取swagger文档并完成解析，最后聚合产出新的API文档。
+
+## 4. 演示效果
+
+### 4.1 API文档列表
+
+在`Apache ShenYu`网关管理系统 --> 文档说明 --> API文档，你可以看到已经聚合好的API文档。
+
+
+
+### 4.2 API详情效果
+
+
+
+## 5. 如何自动更新API文档
+
+### 5.1 重启项目
+
+如上面示例那样，通过启动项目触发自动更新API文档。
+
+### 5.2 修改proxy插件选择器的启动时间
+
+在 proxy插件--> 选择器，找到目标服务，然后修改启动时间。
+> 注意：新设置的启动时间一定不能早于原启动时间，否则不会触发自动拉取并刷新API文档。
+
+
diff --git a/static/img/shenyu/api-doc/apidoc-detail-cn.png
b/static/img/shenyu/api-doc/apidoc-detail-cn.png
new file mode 100644
index 0000000000..eb4e4ec24e
Binary files /dev/null and b/static/img/shenyu/api-doc/apidoc-detail-cn.png
differ
diff --git a/static/img/shenyu/api-doc/apidoc-detail-en.png
b/static/img/shenyu/api-doc/apidoc-detail-en.png
new file mode 100644
index 0000000000..3c825b87b3
Binary files /dev/null and b/static/img/shenyu/api-doc/apidoc-detail-en.png
differ
diff --git a/static/img/shenyu/api-doc/apidoc-dictionary-cn.png
b/static/img/shenyu/api-doc/apidoc-dictionary-cn.png
new file mode 100644
index 0000000000..10254119cf
Binary files /dev/null and b/static/img/shenyu/api-doc/apidoc-dictionary-cn.png
differ
diff --git a/static/img/shenyu/api-doc/apidoc-dictionary-en.png
b/static/img/shenyu/api-doc/apidoc-dictionary-en.png
new file mode 100644
index 0000000000..85acdb45d1
Binary files /dev/null and b/static/img/shenyu/api-doc/apidoc-dictionary-en.png
differ
diff --git a/static/img/shenyu/api-doc/apidoc-swagger-list-cn.png
b/static/img/shenyu/api-doc/apidoc-swagger-list-cn.png
new file mode 100644
index 0000000000..5b07857dda
Binary files /dev/null and
b/static/img/shenyu/api-doc/apidoc-swagger-list-cn.png differ
diff --git a/static/img/shenyu/api-doc/apidoc-swagger-list-en.png
b/static/img/shenyu/api-doc/apidoc-swagger-list-en.png
new file mode 100644
index 0000000000..1e4f87aab8
Binary files /dev/null and
b/static/img/shenyu/api-doc/apidoc-swagger-list-en.png differ
diff --git a/static/img/shenyu/api-doc/app-proxy-startuptime-cn.png
b/static/img/shenyu/api-doc/app-proxy-startuptime-cn.png
new file mode 100644
index 0000000000..48d201b1f1
Binary files /dev/null and
b/static/img/shenyu/api-doc/app-proxy-startuptime-cn.png differ
diff --git a/static/img/shenyu/api-doc/app-proxy-startuptime-en.png
b/static/img/shenyu/api-doc/app-proxy-startuptime-en.png
new file mode 100644
index 0000000000..7b2daead3f
Binary files /dev/null and
b/static/img/shenyu/api-doc/app-proxy-startuptime-en.png differ
diff --git
a/static/img/shenyu/basicConfig/apiManagement/api-published-divide-list-cn.png
b/static/img/shenyu/basicConfig/apiManagement/api-published-divide-list-cn.png
new file mode 100644
index 0000000000..eca6c7f09e
Binary files /dev/null and
b/static/img/shenyu/basicConfig/apiManagement/api-published-divide-list-cn.png
differ
diff --git
a/static/img/shenyu/basicConfig/apiManagement/api-published-divide-list-en.png
b/static/img/shenyu/basicConfig/apiManagement/api-published-divide-list-en.png
new file mode 100644
index 0000000000..9d5cafe4fd
Binary files /dev/null and
b/static/img/shenyu/basicConfig/apiManagement/api-published-divide-list-en.png
differ
diff --git a/static/img/shenyu/basicConfig/apiManagement/apidoc-env-cn.png
b/static/img/shenyu/basicConfig/apiManagement/apidoc-env-cn.png
new file mode 100644
index 0000000000..8ba73def4d
Binary files /dev/null and
b/static/img/shenyu/basicConfig/apiManagement/apidoc-env-cn.png differ
diff --git a/static/img/shenyu/basicConfig/apiManagement/apidoc-env-en.png
b/static/img/shenyu/basicConfig/apiManagement/apidoc-env-en.png
new file mode 100644
index 0000000000..f96f504f64
Binary files /dev/null and
b/static/img/shenyu/basicConfig/apiManagement/apidoc-env-en.png differ
diff --git a/static/img/shenyu/basicConfig/apiManagement/app-create-cn.png
b/static/img/shenyu/basicConfig/apiManagement/app-create-cn.png
new file mode 100644
index 0000000000..ba363d463d
Binary files /dev/null and
b/static/img/shenyu/basicConfig/apiManagement/app-create-cn.png differ
diff --git a/static/img/shenyu/basicConfig/apiManagement/app-create-en.png
b/static/img/shenyu/basicConfig/apiManagement/app-create-en.png
new file mode 100644
index 0000000000..81b50d0ed9
Binary files /dev/null and
b/static/img/shenyu/basicConfig/apiManagement/app-create-en.png differ
diff --git a/static/img/shenyu/basicConfig/apiManagement/create-api-cn.png
b/static/img/shenyu/basicConfig/apiManagement/create-api-cn.png
index 13027690c7..795680d898 100644
Binary files a/static/img/shenyu/basicConfig/apiManagement/create-api-cn.png
and b/static/img/shenyu/basicConfig/apiManagement/create-api-cn.png differ
diff --git a/static/img/shenyu/basicConfig/apiManagement/create-api-en.png
b/static/img/shenyu/basicConfig/apiManagement/create-api-en.png
index b6608b0a27..2a4128ba7f 100644
Binary files a/static/img/shenyu/basicConfig/apiManagement/create-api-en.png
and b/static/img/shenyu/basicConfig/apiManagement/create-api-en.png differ
diff --git a/static/img/shenyu/basicConfig/apiManagement/create-tag-1-cn.png
b/static/img/shenyu/basicConfig/apiManagement/create-tag-1-cn.png
deleted file mode 100644
index 07dd1c8be7..0000000000
Binary files a/static/img/shenyu/basicConfig/apiManagement/create-tag-1-cn.png
and /dev/null differ
diff --git a/static/img/shenyu/basicConfig/apiManagement/create-tag-1-en.png
b/static/img/shenyu/basicConfig/apiManagement/create-tag-1-en.png
deleted file mode 100644
index 70d9b480ca..0000000000
Binary files a/static/img/shenyu/basicConfig/apiManagement/create-tag-1-en.png
and /dev/null differ
diff --git a/static/img/shenyu/basicConfig/apiManagement/create-tag-2-cn.png
b/static/img/shenyu/basicConfig/apiManagement/create-tag-2-cn.png
deleted file mode 100644
index 137e57311d..0000000000
Binary files a/static/img/shenyu/basicConfig/apiManagement/create-tag-2-cn.png
and /dev/null differ
diff --git a/static/img/shenyu/basicConfig/apiManagement/create-tag-2-en.png
b/static/img/shenyu/basicConfig/apiManagement/create-tag-2-en.png
deleted file mode 100644
index 294bcc9a1f..0000000000
Binary files a/static/img/shenyu/basicConfig/apiManagement/create-tag-2-en.png
and /dev/null differ
diff --git a/static/img/shenyu/basicConfig/apiManagement/publish-api-cn.png
b/static/img/shenyu/basicConfig/apiManagement/publish-api-cn.png
index d25de468a8..2a0586e07c 100644
Binary files a/static/img/shenyu/basicConfig/apiManagement/publish-api-cn.png
and b/static/img/shenyu/basicConfig/apiManagement/publish-api-cn.png differ
diff --git a/static/img/shenyu/basicConfig/apiManagement/publish-api-en.png
b/static/img/shenyu/basicConfig/apiManagement/publish-api-en.png
index 7d85e6079c..a8b00cbf4c 100644
Binary files a/static/img/shenyu/basicConfig/apiManagement/publish-api-en.png
and b/static/img/shenyu/basicConfig/apiManagement/publish-api-en.png differ
