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 e4521f6f30 [doc: developer] modify multilingual HTTP client's
documentation. (#736)
e4521f6f30 is described below
commit e4521f6f3087641caf05a56c8ea6c1c7d8d25fdc
Author: lahmxu <[email protected]>
AuthorDate: Thu Sep 8 20:43:20 2022 +0800
[doc: developer] modify multilingual HTTP client's documentation. (#736)
* [doc: developer] modify multilingual HTTP client's documentation.
* [doc: developer] rename `not null` to `required`.
---
docs/developer/developer-shenyu-client.md | 194 +++++++++++++++++---
.../current/developer/developer-shenyu-client.md | 184 +++++++++++++++++--
.../developer/developer-shenyu-client.md | 184 +++++++++++++++++--
.../developer/developer-shenyu-client.md | 184 +++++++++++++++++--
.../developer/developer-shenyu-client.md | 184 +++++++++++++++++--
.../developer/developer-shenyu-client.md | 184 +++++++++++++++++--
.../developer/developer-shenyu-client.md | 184 +++++++++++++++++--
.../developer/developer-shenyu-client.md | 195 ++++++++++++++++++---
.../developer/developer-shenyu-client.md | 195 ++++++++++++++++++---
.../developer/developer-shenyu-client.md | 194 +++++++++++++++++---
.../developer/developer-shenyu-client.md | 194 +++++++++++++++++---
.../developer/developer-shenyu-client.md | 194 +++++++++++++++++---
12 files changed, 2024 insertions(+), 246 deletions(-)
diff --git a/docs/developer/developer-shenyu-client.md
b/docs/developer/developer-shenyu-client.md
index 5565402355..44346cb115 100644
--- a/docs/developer/developer-shenyu-client.md
+++ b/docs/developer/developer-shenyu-client.md
@@ -7,29 +7,179 @@ description: A multilingual HTTP client
## Description
* This document focuses on how to access gateways for `HTTP` services in other
languages.
-* How to customize the development of `shenyu-http-client`.
-
-## Customize Http Client
-
-* Request Method: `POST`
-* Request Path: `http://soul-admin/soul-client/springmvc-register`,
shenyu-admin represents `IP + Port` of admin
-* Request Params：passing `JSON` type parameters through the body.
-
-```json
-{
- "appName": "xxx", //required
- "context": "/xxx", //required
- "path": "xxx", //required
- "pathDesc": "xxx",
- "rpcType": "http", //required
- "host": "xxx", //required
- "port": xxx, //required
- "ruleName": "xxx", //required
- "enabled": "true", //required
- "registerMetaData": "true" //required
-}
-```
+* To access the gateway, you need to get the token first, and then you can
call the registration service or metadata interface according to your needs.
+## Get token
+
+- **Request Method**
+
+ `GET`
+
+- **Request Path**
+ - `http://{shenyu-admin}/platform/login`
+ - Where `shenyu-admin` is the `ip + port` of the `admin` backend
management system.
+
+
+- **Request Params**
+
+ - `query` parameter, the account password is the username and password of
the admin service.
+
+ | Field | Type | Required | Desc |
+ | -------- | ------ | --------- | --------------------- |
+ | userName | String | Yes | shenyu admin account |
+ | password | String | Yes | shenyu admin password |
+
+- **Return Data**
+
+ | Field | | Type | Desc |
+ | ------- | ----------- | ------- | ----------------------------- |
+ | code | | Integer | Return code |
+ | message | | String | Return message |
+ | data | | Object | Return data |
+ | | id | Integer | user id |
+ | | userName | String | account |
+ | | role | Integer | role id |
+ | | enabled | Boolean | status |
+ | | dateCreated | String | create time |
+ | | dateUpdated | String | update time |
+ | | token | String | token |
+ | | expiredTime | Long | timeout time, in milliseconds |
+
+ **Example**
+
+ ```json
+ {
+ "code": 200,
+ "message": "login dashboard user success",
+ "data": {
+ "id": "1",
+ "userName": "admin",
+ "role": 1,
+ "enabled": true,
+ "dateCreated": "2022-09-07 22:08:23",
+ "dateUpdated": "2022-09-07 22:08:23",
+ "token":
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyTmFtZSI6ImFkbWluIiwiZXhwIjoxNjYyNjQ2MzU5fQ.WBXBgCcGsnnC00pRbDOtqCVoAaZr8MKH6WE6kY-NGaI",
+ "expiredTime": 86400000
+ }
+ }
+ ```
+
+
+
+## Registration Services
+
+- **Request Method**
+
+ `POST`
+
+- **Request Path**
+ - `http://{shenyu-admin}/shenyu-client/register-uri`
+ - Where `shenyu-admin` is the `ip + port` of the `admin` backend
management system.
+
+
+* **Request Params**
+
+ - `Header`
+
+ - `contentType: application/json`
+
+ - `X-Access-Token: {token}`，token is the token obtained by `Get token`.
+
+ - `Body`，`json` format
+
+ | Field | Type | Required | Desc
|
+ | ----------- | -------
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
------------------------------------------------------------ |
+ | protocol | String | Yes | protocol type
|
+ | appName | String | Yes | app name
|
+ | contextPath | String | Yes | service path
|
+ | rpcType | String | Yes | rpc type, supported type reference
[RpcTypeEnum](https://github.com/apache/shenyu/blob/master/shenyu-common/src/main/java/org/apache/shenyu/common/enums/RpcTypeEnum.java)
|
+ | host | String | Yes | service IP
|
+ | port | Integer | Yes | service port
|
+ | eventType | String | Yes | event type, supported types
reference
[EventType](https://github.com/apache/shenyu/blob/master/shenyu-register-center/shenyu-register-common/src/main/java/org/apache/shenyu/register/common/enums/EventType.java)
|
+
+ **Example**
+
+ ```json
+ {
+ "protocol": "http",
+ "appName": "app",
+ "contextPath": "/test",
+ "rpcType": "http",
+ "host": "127.0.0.1",
+ "port": "8080",
+ "eventType": "REGISTER"
+ }
+ ```
+
+- **Return Data**
+
+ A successful registration returns `success`.
+
+## Registration Metadata
+
+- **Request Method**
+
+ `POST`
+
+- **Request Path**
+
+ - `http://{shenyu-admin}/shenyu-client/register-metadata`
+ - Where `shenyu-admin` is the `ip + port` of the `admin` backend
management system.
+
+- **Request Params**
+
+ - `Header`
+
+ - `contentType: application/json`
+
+ - `X-Access-Token: {token}`，token is the token obtained by `Get token`.
+
+ - `Body`，`json` format.
+
+ | Field | Type | Required | Desc
|
+ | ---------------- | -------
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
------------------------------------------------------------ |
+ | appName | String | Yes | app name
|
+ | contextPath | String | Yes | service path
|
+ | path | String | Yes | path
|
+ | pathDesc | String | Yes | path description
|
+ | rpcType | String | Yes | rpc type, supported type
reference
[RpcTypeEnum](https://github.com/apache/shenyu/blob/master/shenyu-common/src/main/java/org/apache/shenyu/common/enums/RpcTypeEnum.java)
|
+ | serviceName | String | Yes | service name
|
+ | methodName | String | Yes | method name
|
+ | ruleName | String | Yes | rule name
|
+ | parameterTypes | String | Yes | parameter Type
|
+ | rpcExt | String | Yes | rpc expansion parameters
|
+ | enabled | Boolean | No | status
|
+ | host | String | Yes | service IP
|
+ | port | Integer | Yes | service port
|
+ | pluginNames | List | No | plugin name list
|
+ | registerMetaData | Boolean | No | whether to register metadata
|
+
+ **examples**
+
+ ```json
+ {
+ "appName": "app",
+ "contextPath": "/",
+ "path": "/test",
+ "rpcType": "http",
+ "serviceName": "test service",
+ "parameterTypes": "java.lang.String",
+ "pathDesc": "test path",
+ "methodName": "test method",
+ "ruleName": "test rule",
+ "rpcExt": "{\"loadbalance\":\"hash\",\"retries\":3,\"timeout\":-1}",
+ "enabled": true,
+ "host": "127.0.0.1",
+ "port": 8080,
+ "pluginNames": [],
+ "registerMetaData": true
+ }
+ ```
+
+- **Return Data**
+
+ A successful registration returns `success`.
+
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/current/developer/developer-shenyu-client.md
b/i18n/zh/docusaurus-plugin-content-docs/current/developer/developer-shenyu-client.md
index a98320316a..4da3bce1d1 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/current/developer/developer-shenyu-client.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/current/developer/developer-shenyu-client.md
@@ -7,32 +7,178 @@ description: 多语言http客户端
## 说明
* 本文主要讲解其他语言的`http`服务如何接入网关。
-* 如何自定义开发`shenyu-http-client`。
+* 接入网关需要先获取 token, 然后可以根据需求调用注册服务或元数据接口
-## 自定义开发
-* 请求方式：`POST`
-* 请求路径：`http://shenyu-admin/shenyu-client/springmvc-register` ， 其中
`shenyu-admin` 表示为 `admin` 后台管理系统的 `ip + port` 。
+## 获取 token
-* 请求参数：`Apache ShenYu`网关默认的需要参数，通过`body`里面传入，`json`类型。
+- **请求方式**
-```json
-{
- "appName": "xxx", //应用名称 必填
- "context": "/xxx", //请求前缀 必填
- "path": "xxx", //路径需要唯一 必填
- "pathDesc": "xxx", //路径描述
- "rpcType": "http", //rpc类型 必填
- "host": "xxx", //服务host 必填
- "port": xxx, //服务端口 必填
- "ruleName": "xxx", //可以同path一样 必填
- "enabled": "true", //是否开启
- "registerMetaData": "true" //是否需要注册元数据
-}
-```
+ `GET`
+- **请求路径**
+ - `http://{shenyu-admin}/platform/login`
+ - 其中 `shenyu-admin` 表示为 `admin` 后台管理系统的 `ip + port`
+- **请求参数**
+
+ - `query`参数，账号密码为 admin 服务的用户名和密码
+
+ | 字段 | 类型 | 是否必填 | 描述 |
+ | -------- | ------ | -------- | ------ |
+ | userName | String | 是 | 用户名 |
+ | password | String | 是 | 密码 |
+
+- **返回数据**
+
+ | 字段 | | 类型 | 描述 |
+ | ------- | ----------- | ------- | -------------------- |
+ | code | | Integer | 返回码 |
+ | message | | String | 返回信息 |
+ | data | | Object | 返回对象 |
+ | | id | Integer | 用户id |
+ | | userName | String | 账号 |
+ | | role | Integer | 角色 |
+ | | enabled | Boolean | 是否启用 |
+ | | dateCreated | String | 创建时间 |
+ | | dateUpdated | String | 更新时间 |
+ | | token | String | token |
+ | | expiredTime | Long | 超时时间，单位：毫秒 |
+
+ **示例**
+
+ ```json
+ {
+ "code": 200,
+ "message": "login dashboard user success",
+ "data": {
+ "id": "1",
+ "userName": "admin",
+ "role": 1,
+ "enabled": true,
+ "dateCreated": "2022-09-07 22:08:23",
+ "dateUpdated": "2022-09-07 22:08:23",
+ "token":
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyTmFtZSI6ImFkbWluIiwiZXhwIjoxNjYyNjQ2MzU5fQ.WBXBgCcGsnnC00pRbDOtqCVoAaZr8MKH6WE6kY-NGaI",
+ "expiredTime": 86400000
+ }
+ }
+ ```
+
+## 注册服务
+
+- **请求方式**
+
+ `POST`
+
+- **请求路径**
+ - `http://{shenyu-admin}/shenyu-client/register-uri`
+ - 其中 `shenyu-admin` 表示为 `admin` 后台管理系统的 `ip + port`
+
+
+- **请求参数**
+
+ - `Header`参数
+
+ - `contentType: application/json`
+
+ - `X-Access-Token: {token}`，token 为调用登陆接口获取的 token
+
+ - `Body`参数，`json`类型
+
+ | 字段 | 类型 | 是否必填 | 描述
|
+ | ----------- | ------- | -------- |
------------------------------------------------------------ |
+ | protocol | String | 是 | 协议类型
|
+ | appName | String | 是 | 应用名称
|
+ | contextPath | String | 是 | 项目路径
|
+ | rpcType | String | 是 | rpc类型，支持的类型参考
[RpcTypeEnum](https://github.com/apache/shenyu/blob/master/shenyu-common/src/main/java/org/apache/shenyu/common/enums/RpcTypeEnum.java)
|
+ | host | String | 是 | 客户端IP
|
+ | port | Integer | 是 | 客户端端口
|
+ | eventType | String | 是 | 事件类型，支持的类型参考
[EventType](https://github.com/apache/shenyu/blob/master/shenyu-register-center/shenyu-register-common/src/main/java/org/apache/shenyu/register/common/enums/EventType.java)
|
+
+ **示例**
+
+ ```json
+ {
+ "protocol": "http",
+ "appName": "app",
+ "contextPath": "/test",
+ "rpcType": "http",
+ "host": "127.0.0.1",
+ "port": "8080",
+ "eventType": "REGISTER"
+ }
+ ```
+
+- **返回数据**
+
+ 注册成功会返回 `success`
+
+
+
+
+## 注册元数据
+
+- **请求方式**
+
+ `POST`
+
+- **请求路径**
+ - `http://{shenyu-admin}/shenyu-client/register-metadata`
+ - 其中 `shenyu-admin` 表示为 `admin` 后台管理系统的 `ip + port`
+
+- **请求参数**
+ - `Header`参数
+
+ - `contentType: application/json`
+
+ - `X-Access-Token: {token}`，token 为调用登陆接口获取的 token
+
+ - `Body`参数，`json`类型
+
+ | 字段 | 类型 | 是否必填 | 描述
|
+ | ---------------- | ------------ | -------- |
------------------------------------------------------------ |
+ | appName | String | 是 | 应用名称
|
+ | contextPath | String | 是 | 项目路径
|
+ | path | String | 是 | 路径
|
+ | pathDesc | String | 是 | 路径描述
|
+ | rpcType | String | 是 | rpc类型，支持的类型参考
[RpcTypeEnum](https://github.com/apache/shenyu/blob/master/shenyu-common/src/main/java/org/apache/shenyu/common/enums/RpcTypeEnum.java)
|
+ | serviceName | String | 是 | 服务名称
|
+ | methodName | String | 是 | 方法名称
|
+ | ruleName | String | 是 | 规则名称
|
+ | parameterTypes | String | 是 | 参数类型
|
+ | rpcExt | String | 是 | Rpc拓展参数
|
+ | enabled | Boolean | 否 | 状态
|
+ | host | String | 是 | 服务 IP
|
+ | port | Integer | 是 | 服务端口
|
+ | pluginNames | List | 是 | 插件名称列表
|
+ | registerMetaData | Boolean | 否 | 是否注册元数据
|
+
+ **示例**
+
+ ```json
+ {
+ "appName": "app",
+ "contextPath": "/",
+ "path": "/test",
+ "rpcType": "http",
+ "serviceName": "测试服务",
+ "parameterTypes": "java.lang.String",
+ "pathDesc": "测试路径",
+ "methodName": "测试方法",
+ "ruleName": "测试规则",
+ "rpcExt": "{\"loadbalance\":\"hash\",\"retries\":3,\"timeout\":-1}",
+ "enabled": true,
+ "host": "127.0.0.1",
+ "port": 8080,
+ "pluginNames": [],
+ "registerMetaData": true
+ }
+ ```
+
+- **返回数据**
+
+ 注册成功会返回 `success`
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.0/developer/developer-shenyu-client.md
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.0/developer/developer-shenyu-client.md
index a98320316a..daa0037a14 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.0/developer/developer-shenyu-client.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.0/developer/developer-shenyu-client.md
@@ -7,32 +7,178 @@ description: 多语言http客户端
## 说明
* 本文主要讲解其他语言的`http`服务如何接入网关。
-* 如何自定义开发`shenyu-http-client`。
+* 接入网关需要先获取 token, 然后可以根据需求调用注册服务或元数据接口
-## 自定义开发
-* 请求方式：`POST`
-* 请求路径：`http://shenyu-admin/shenyu-client/springmvc-register` ， 其中
`shenyu-admin` 表示为 `admin` 后台管理系统的 `ip + port` 。
+## 获取 token
-* 请求参数：`Apache ShenYu`网关默认的需要参数，通过`body`里面传入，`json`类型。
+- **请求方式**
-```json
-{
- "appName": "xxx", //应用名称 必填
- "context": "/xxx", //请求前缀 必填
- "path": "xxx", //路径需要唯一 必填
- "pathDesc": "xxx", //路径描述
- "rpcType": "http", //rpc类型 必填
- "host": "xxx", //服务host 必填
- "port": xxx, //服务端口 必填
- "ruleName": "xxx", //可以同path一样 必填
- "enabled": "true", //是否开启
- "registerMetaData": "true" //是否需要注册元数据
-}
-```
+ `GET`
+- **请求路径**
+ - `http://{shenyu-admin}/platform/login`
+ - 其中 `shenyu-admin` 表示为 `admin` 后台管理系统的 `ip + port`
+- **请求参数**
+
+ - `query`参数，账号密码为 admin 服务的用户名和密码
+
+ | 字段 | 类型 | 是否必填 | 描述 |
+ | -------- | ------ | -------- | ------ |
+ | userName | String | 是 | 用户名 |
+ | password | String | 是 | 密码 |
+
+- **返回数据**
+
+ | 字段 | | 类型 | 描述 |
+ | ------- | ----------- | ------- | -------------------- |
+ | code | | Integer | 返回码 |
+ | message | | String | 返回信息 |
+ | data | | Object | 返回对象 |
+ | | id | Integer | 用户id |
+ | | userName | String | 账号 |
+ | | role | Integer | 角色 |
+ | | enabled | Boolean | 是否启用 |
+ | | dateCreated | String | 创建时间 |
+ | | dateUpdated | String | 更新时间 |
+ | | token | String | token |
+ | | expiredTime | Long | 超时时间，单位：毫秒 |
+
+ **示例**
+
+ ```json
+ {
+ "code": 200,
+ "message": "login dashboard user success",
+ "data": {
+ "id": "1",
+ "userName": "admin",
+ "role": 1,
+ "enabled": true,
+ "dateCreated": "2022-09-07 22:08:23",
+ "dateUpdated": "2022-09-07 22:08:23",
+ "token":
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyTmFtZSI6ImFkbWluIiwiZXhwIjoxNjYyNjQ2MzU5fQ.WBXBgCcGsnnC00pRbDOtqCVoAaZr8MKH6WE6kY-NGaI",
+ "expiredTime": 86400000
+ }
+ }
+ ```
+
+## 注册服务
+
+- **请求方式**
+
+ `POST`
+
+- **请求路径**
+ - `http://{shenyu-admin}/shenyu-client/register-uri`
+ - 其中 `shenyu-admin` 表示为 `admin` 后台管理系统的 `ip + port`
+
+
+- **请求参数**
+
+ - `Header`参数
+
+ - `contentType: application/json`
+
+ - `X-Access-Token: {token}`，token 为调用登陆接口获取的 token
+
+ - `Body`参数，`json`类型
+
+ | 字段 | 类型 | 是否必填 | 描述
|
+ | ----------- | ------- | -------- |
------------------------------------------------------------ |
+ | protocol | String | 是 | 协议类型
|
+ | appName | String | 是 | 应用名称
|
+ | contextPath | String | 是 | 项目路径
|
+ | rpcType | String | 是 | rpc类型，支持的类型参考
[RpcTypeEnum](https://github.com/apache/shenyu/blob/v2.4.0/shenyu-common/src/main/java/org/apache/shenyu/common/enums/RpcTypeEnum.java)
|
+ | host | String | 是 | 客户端IP
|
+ | port | Integer | 是 | 客户端端口
|
+ | eventType | String | 是 | 事件类型，支持的类型参考
[EventType](https://github.com/apache/shenyu/blob/v2.4.0/shenyu-register-center/shenyu-register-common/src/main/java/org/apache/shenyu/register/common/enums/EventType.java)
|
+
+ **示例**
+
+ ```json
+ {
+ "protocol": "http",
+ "appName": "app",
+ "contextPath": "/test",
+ "rpcType": "http",
+ "host": "127.0.0.1",
+ "port": "8080",
+ "eventType": "REGISTER"
+ }
+ ```
+
+- **返回数据**
+
+ 注册成功会返回 `success`
+
+
+
+
+## 注册元数据
+
+- **请求方式**
+
+ `POST`
+
+- **请求路径**
+ - `http://{shenyu-admin}/shenyu-client/register-metadata`
+ - 其中 `shenyu-admin` 表示为 `admin` 后台管理系统的 `ip + port`
+
+- **请求参数**
+ - `Header`参数
+
+ - `contentType: application/json`
+
+ - `X-Access-Token: {token}`，token 为调用登陆接口获取的 token
+
+ - `Body`参数，`json`类型
+
+ | 字段 | 类型 | 是否必填 | 描述
|
+ | ---------------- | ------------ | -------- |
------------------------------------------------------------ |
+ | appName | String | 是 | 应用名称
|
+ | contextPath | String | 是 | 项目路径
|
+ | path | String | 是 | 路径
|
+ | pathDesc | String | 是 | 路径描述
|
+ | rpcType | String | 是 | rpc类型，支持的类型参考
[RpcTypeEnum](https://github.com/apache/shenyu/blob/v2.4.0/shenyu-common/src/main/java/org/apache/shenyu/common/enums/RpcTypeEnum.java)
|
+ | serviceName | String | 是 | 服务名称
|
+ | methodName | String | 是 | 方法名称
|
+ | ruleName | String | 是 | 规则名称
|
+ | parameterTypes | String | 是 | 参数类型
|
+ | rpcExt | String | 是 | Rpc拓展参数
|
+ | enabled | Boolean | 否 | 状态
|
+ | host | String | 是 | 服务 IP
|
+ | port | Integer | 是 | 服务端口
|
+ | pluginNames | List | 是 | 插件名称列表
|
+ | registerMetaData | Boolean | 否 | 是否注册元数据
|
+
+ **示例**
+
+ ```json
+ {
+ "appName": "app",
+ "contextPath": "/",
+ "path": "/test",
+ "rpcType": "http",
+ "serviceName": "测试服务",
+ "parameterTypes": "java.lang.String",
+ "pathDesc": "测试路径",
+ "methodName": "测试方法",
+ "ruleName": "测试规则",
+ "rpcExt": "{\"loadbalance\":\"hash\",\"retries\":3,\"timeout\":-1}",
+ "enabled": true,
+ "host": "127.0.0.1",
+ "port": 8080,
+ "pluginNames": [],
+ "registerMetaData": true
+ }
+ ```
+
+- **返回数据**
+
+ 注册成功会返回 `success`
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.1/developer/developer-shenyu-client.md
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.1/developer/developer-shenyu-client.md
index a98320316a..1e06812c12 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.1/developer/developer-shenyu-client.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.1/developer/developer-shenyu-client.md
@@ -7,32 +7,178 @@ description: 多语言http客户端
## 说明
* 本文主要讲解其他语言的`http`服务如何接入网关。
-* 如何自定义开发`shenyu-http-client`。
+* 接入网关需要先获取 token, 然后可以根据需求调用注册服务或元数据接口
-## 自定义开发
-* 请求方式：`POST`
-* 请求路径：`http://shenyu-admin/shenyu-client/springmvc-register` ， 其中
`shenyu-admin` 表示为 `admin` 后台管理系统的 `ip + port` 。
+## 获取 token
-* 请求参数：`Apache ShenYu`网关默认的需要参数，通过`body`里面传入，`json`类型。
+- **请求方式**
-```json
-{
- "appName": "xxx", //应用名称 必填
- "context": "/xxx", //请求前缀 必填
- "path": "xxx", //路径需要唯一 必填
- "pathDesc": "xxx", //路径描述
- "rpcType": "http", //rpc类型 必填
- "host": "xxx", //服务host 必填
- "port": xxx, //服务端口 必填
- "ruleName": "xxx", //可以同path一样 必填
- "enabled": "true", //是否开启
- "registerMetaData": "true" //是否需要注册元数据
-}
-```
+ `GET`
+- **请求路径**
+ - `http://{shenyu-admin}/platform/login`
+ - 其中 `shenyu-admin` 表示为 `admin` 后台管理系统的 `ip + port`
+- **请求参数**
+
+ - `query`参数，账号密码为 admin 服务的用户名和密码
+
+ | 字段 | 类型 | 是否必填 | 描述 |
+ | -------- | ------ | -------- | ------ |
+ | userName | String | 是 | 用户名 |
+ | password | String | 是 | 密码 |
+
+- **返回数据**
+
+ | 字段 | | 类型 | 描述 |
+ | ------- | ----------- | ------- | -------------------- |
+ | code | | Integer | 返回码 |
+ | message | | String | 返回信息 |
+ | data | | Object | 返回对象 |
+ | | id | Integer | 用户id |
+ | | userName | String | 账号 |
+ | | role | Integer | 角色 |
+ | | enabled | Boolean | 是否启用 |
+ | | dateCreated | String | 创建时间 |
+ | | dateUpdated | String | 更新时间 |
+ | | token | String | token |
+ | | expiredTime | Long | 超时时间，单位：毫秒 |
+
+ **示例**
+
+ ```json
+ {
+ "code": 200,
+ "message": "login dashboard user success",
+ "data": {
+ "id": "1",
+ "userName": "admin",
+ "role": 1,
+ "enabled": true,
+ "dateCreated": "2022-09-07 22:08:23",
+ "dateUpdated": "2022-09-07 22:08:23",
+ "token":
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyTmFtZSI6ImFkbWluIiwiZXhwIjoxNjYyNjQ2MzU5fQ.WBXBgCcGsnnC00pRbDOtqCVoAaZr8MKH6WE6kY-NGaI",
+ "expiredTime": 86400000
+ }
+ }
+ ```
+
+## 注册服务
+
+- **请求方式**
+
+ `POST`
+
+- **请求路径**
+ - `http://{shenyu-admin}/shenyu-client/register-uri`
+ - 其中 `shenyu-admin` 表示为 `admin` 后台管理系统的 `ip + port`
+
+
+- **请求参数**
+
+ - `Header`参数
+
+ - `contentType: application/json`
+
+ - `X-Access-Token: {token}`，token 为调用登陆接口获取的 token
+
+ - `Body`参数，`json`类型
+
+ | 字段 | 类型 | 是否必填 | 描述
|
+ | ----------- | ------- | -------- |
------------------------------------------------------------ |
+ | protocol | String | 是 | 协议类型
|
+ | appName | String | 是 | 应用名称
|
+ | contextPath | String | 是 | 项目路径
|
+ | rpcType | String | 是 | rpc类型，支持的类型参考
[RpcTypeEnum](https://github.com/apache/shenyu/blob/v2.4.1/shenyu-common/src/main/java/org/apache/shenyu/common/enums/RpcTypeEnum.java)
|
+ | host | String | 是 | 客户端IP
|
+ | port | Integer | 是 | 客户端端口
|
+ | eventType | String | 是 | 事件类型，支持的类型参考
[EventType](https://github.com/apache/shenyu/blob/v2.4.1/shenyu-register-center/shenyu-register-common/src/main/java/org/apache/shenyu/register/common/enums/EventType.java)
|
+
+ **示例**
+
+ ```json
+ {
+ "protocol": "http",
+ "appName": "app",
+ "contextPath": "/test",
+ "rpcType": "http",
+ "host": "127.0.0.1",
+ "port": "8080",
+ "eventType": "REGISTER"
+ }
+ ```
+
+- **返回数据**
+
+ 注册成功会返回 `success`
+
+
+
+
+## 注册元数据
+
+- **请求方式**
+
+ `POST`
+
+- **请求路径**
+ - `http://{shenyu-admin}/shenyu-client/register-metadata`
+ - 其中 `shenyu-admin` 表示为 `admin` 后台管理系统的 `ip + port`
+
+- **请求参数**
+ - `Header`参数
+
+ - `contentType: application/json`
+
+ - `X-Access-Token: {token}`，token 为调用登陆接口获取的 token
+
+ - `Body`参数，`json`类型
+
+ | 字段 | 类型 | 是否必填 | 描述
|
+ | ---------------- | ------------ | -------- |
------------------------------------------------------------ |
+ | appName | String | 是 | 应用名称
|
+ | contextPath | String | 是 | 项目路径
|
+ | path | String | 是 | 路径
|
+ | pathDesc | String | 是 | 路径描述
|
+ | rpcType | String | 是 | rpc类型，支持的类型参考
[RpcTypeEnum](https://github.com/apache/shenyu/blob/v2.4.1/shenyu-common/src/main/java/org/apache/shenyu/common/enums/RpcTypeEnum.java)
|
+ | serviceName | String | 是 | 服务名称
|
+ | methodName | String | 是 | 方法名称
|
+ | ruleName | String | 是 | 规则名称
|
+ | parameterTypes | String | 是 | 参数类型
|
+ | rpcExt | String | 是 | Rpc拓展参数
|
+ | enabled | Boolean | 否 | 状态
|
+ | host | String | 是 | 服务 IP
|
+ | port | Integer | 是 | 服务端口
|
+ | pluginNames | List | 是 | 插件名称列表
|
+ | registerMetaData | Boolean | 否 | 是否注册元数据
|
+
+ **示例**
+
+ ```json
+ {
+ "appName": "app",
+ "contextPath": "/",
+ "path": "/test",
+ "rpcType": "http",
+ "serviceName": "测试服务",
+ "parameterTypes": "java.lang.String",
+ "pathDesc": "测试路径",
+ "methodName": "测试方法",
+ "ruleName": "测试规则",
+ "rpcExt": "{\"loadbalance\":\"hash\",\"retries\":3,\"timeout\":-1}",
+ "enabled": true,
+ "host": "127.0.0.1",
+ "port": 8080,
+ "pluginNames": [],
+ "registerMetaData": true
+ }
+ ```
+
+- **返回数据**
+
+ 注册成功会返回 `success`
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/developer/developer-shenyu-client.md
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/developer/developer-shenyu-client.md
index a98320316a..8d9ca24ce5 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/developer/developer-shenyu-client.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/developer/developer-shenyu-client.md
@@ -7,32 +7,178 @@ description: 多语言http客户端
## 说明
* 本文主要讲解其他语言的`http`服务如何接入网关。
-* 如何自定义开发`shenyu-http-client`。
+* 接入网关需要先获取 token, 然后可以根据需求调用注册服务或元数据接口
-## 自定义开发
-* 请求方式：`POST`
-* 请求路径：`http://shenyu-admin/shenyu-client/springmvc-register` ， 其中
`shenyu-admin` 表示为 `admin` 后台管理系统的 `ip + port` 。
+## 获取 token
-* 请求参数：`Apache ShenYu`网关默认的需要参数，通过`body`里面传入，`json`类型。
+- **请求方式**
-```json
-{
- "appName": "xxx", //应用名称 必填
- "context": "/xxx", //请求前缀 必填
- "path": "xxx", //路径需要唯一 必填
- "pathDesc": "xxx", //路径描述
- "rpcType": "http", //rpc类型 必填
- "host": "xxx", //服务host 必填
- "port": xxx, //服务端口 必填
- "ruleName": "xxx", //可以同path一样 必填
- "enabled": "true", //是否开启
- "registerMetaData": "true" //是否需要注册元数据
-}
-```
+ `GET`
+- **请求路径**
+ - `http://{shenyu-admin}/platform/login`
+ - 其中 `shenyu-admin` 表示为 `admin` 后台管理系统的 `ip + port`
+- **请求参数**
+
+ - `query`参数，账号密码为 admin 服务的用户名和密码
+
+ | 字段 | 类型 | 是否必填 | 描述 |
+ | -------- | ------ | -------- | ------ |
+ | userName | String | 是 | 用户名 |
+ | password | String | 是 | 密码 |
+
+- **返回数据**
+
+ | 字段 | | 类型 | 描述 |
+ | ------- | ----------- | ------- | -------------------- |
+ | code | | Integer | 返回码 |
+ | message | | String | 返回信息 |
+ | data | | Object | 返回对象 |
+ | | id | Integer | 用户id |
+ | | userName | String | 账号 |
+ | | role | Integer | 角色 |
+ | | enabled | Boolean | 是否启用 |
+ | | dateCreated | String | 创建时间 |
+ | | dateUpdated | String | 更新时间 |
+ | | token | String | token |
+ | | expiredTime | Long | 超时时间，单位：毫秒 |
+
+ **示例**
+
+ ```json
+ {
+ "code": 200,
+ "message": "login dashboard user success",
+ "data": {
+ "id": "1",
+ "userName": "admin",
+ "role": 1,
+ "enabled": true,
+ "dateCreated": "2022-09-07 22:08:23",
+ "dateUpdated": "2022-09-07 22:08:23",
+ "token":
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyTmFtZSI6ImFkbWluIiwiZXhwIjoxNjYyNjQ2MzU5fQ.WBXBgCcGsnnC00pRbDOtqCVoAaZr8MKH6WE6kY-NGaI",
+ "expiredTime": 86400000
+ }
+ }
+ ```
+
+## 注册服务
+
+- **请求方式**
+
+ `POST`
+
+- **请求路径**
+ - `http://{shenyu-admin}/shenyu-client/register-uri`
+ - 其中 `shenyu-admin` 表示为 `admin` 后台管理系统的 `ip + port`
+
+
+- **请求参数**
+
+ - `Header`参数
+
+ - `contentType: application/json`
+
+ - `X-Access-Token: {token}`，token 为调用登陆接口获取的 token
+
+ - `Body`参数，`json`类型
+
+ | 字段 | 类型 | 是否必填 | 描述
|
+ | ----------- | ------- | -------- |
------------------------------------------------------------ |
+ | protocol | String | 是 | 协议类型
|
+ | appName | String | 是 | 应用名称
|
+ | contextPath | String | 是 | 项目路径
|
+ | rpcType | String | 是 | rpc类型，支持的类型参考
[RpcTypeEnum](https://github.com/apache/shenyu/blob/v2.4.2/shenyu-common/src/main/java/org/apache/shenyu/common/enums/RpcTypeEnum.java)
|
+ | host | String | 是 | 客户端IP
|
+ | port | Integer | 是 | 客户端端口
|
+ | eventType | String | 是 | 事件类型，支持的类型参考
[EventType](https://github.com/apache/shenyu/blob/v2.4.2/shenyu-register-center/shenyu-register-common/src/main/java/org/apache/shenyu/register/common/enums/EventType.java)
|
+
+ **示例**
+
+ ```json
+ {
+ "protocol": "http",
+ "appName": "app",
+ "contextPath": "/test",
+ "rpcType": "http",
+ "host": "127.0.0.1",
+ "port": "8080",
+ "eventType": "REGISTER"
+ }
+ ```
+
+- **返回数据**
+
+ 注册成功会返回 `success`
+
+
+
+
+## 注册元数据
+
+- **请求方式**
+
+ `POST`
+
+- **请求路径**
+ - `http://{shenyu-admin}/shenyu-client/register-metadata`
+ - 其中 `shenyu-admin` 表示为 `admin` 后台管理系统的 `ip + port`
+
+- **请求参数**
+ - `Header`参数
+
+ - `contentType: application/json`
+
+ - `X-Access-Token: {token}`，token 为调用登陆接口获取的 token
+
+ - `Body`参数，`json`类型
+
+ | 字段 | 类型 | 是否必填 | 描述
|
+ | ---------------- | ------------ | -------- |
------------------------------------------------------------ |
+ | appName | String | 是 | 应用名称
|
+ | contextPath | String | 是 | 项目路径
|
+ | path | String | 是 | 路径
|
+ | pathDesc | String | 是 | 路径描述
|
+ | rpcType | String | 是 | rpc类型，支持的类型参考
[RpcTypeEnum](https://github.com/apache/shenyu/blob/v2.4.2/shenyu-common/src/main/java/org/apache/shenyu/common/enums/RpcTypeEnum.java)
|
+ | serviceName | String | 是 | 服务名称
|
+ | methodName | String | 是 | 方法名称
|
+ | ruleName | String | 是 | 规则名称
|
+ | parameterTypes | String | 是 | 参数类型
|
+ | rpcExt | String | 是 | Rpc拓展参数
|
+ | enabled | Boolean | 否 | 状态
|
+ | host | String | 是 | 服务 IP
|
+ | port | Integer | 是 | 服务端口
|
+ | pluginNames | List | 是 | 插件名称列表
|
+ | registerMetaData | Boolean | 否 | 是否注册元数据
|
+
+ **示例**
+
+ ```json
+ {
+ "appName": "app",
+ "contextPath": "/",
+ "path": "/test",
+ "rpcType": "http",
+ "serviceName": "测试服务",
+ "parameterTypes": "java.lang.String",
+ "pathDesc": "测试路径",
+ "methodName": "测试方法",
+ "ruleName": "测试规则",
+ "rpcExt": "{\"loadbalance\":\"hash\",\"retries\":3,\"timeout\":-1}",
+ "enabled": true,
+ "host": "127.0.0.1",
+ "port": 8080,
+ "pluginNames": [],
+ "registerMetaData": true
+ }
+ ```
+
+- **返回数据**
+
+ 注册成功会返回 `success`
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/developer/developer-shenyu-client.md
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/developer/developer-shenyu-client.md
index a98320316a..fd4ab87ed7 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/developer/developer-shenyu-client.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/developer/developer-shenyu-client.md
@@ -7,32 +7,178 @@ description: 多语言http客户端
## 说明
* 本文主要讲解其他语言的`http`服务如何接入网关。
-* 如何自定义开发`shenyu-http-client`。
+* 接入网关需要先获取 token, 然后可以根据需求调用注册服务或元数据接口
-## 自定义开发
-* 请求方式：`POST`
-* 请求路径：`http://shenyu-admin/shenyu-client/springmvc-register` ， 其中
`shenyu-admin` 表示为 `admin` 后台管理系统的 `ip + port` 。
+## 获取 token
-* 请求参数：`Apache ShenYu`网关默认的需要参数，通过`body`里面传入，`json`类型。
+- **请求方式**
-```json
-{
- "appName": "xxx", //应用名称 必填
- "context": "/xxx", //请求前缀 必填
- "path": "xxx", //路径需要唯一 必填
- "pathDesc": "xxx", //路径描述
- "rpcType": "http", //rpc类型 必填
- "host": "xxx", //服务host 必填
- "port": xxx, //服务端口 必填
- "ruleName": "xxx", //可以同path一样 必填
- "enabled": "true", //是否开启
- "registerMetaData": "true" //是否需要注册元数据
-}
-```
+ `GET`
+- **请求路径**
+ - `http://{shenyu-admin}/platform/login`
+ - 其中 `shenyu-admin` 表示为 `admin` 后台管理系统的 `ip + port`
+- **请求参数**
+
+ - `query`参数，账号密码为 admin 服务的用户名和密码
+
+ | 字段 | 类型 | 是否必填 | 描述 |
+ | -------- | ------ | -------- | ------ |
+ | userName | String | 是 | 用户名 |
+ | password | String | 是 | 密码 |
+
+- **返回数据**
+
+ | 字段 | | 类型 | 描述 |
+ | ------- | ----------- | ------- | -------------------- |
+ | code | | Integer | 返回码 |
+ | message | | String | 返回信息 |
+ | data | | Object | 返回对象 |
+ | | id | Integer | 用户id |
+ | | userName | String | 账号 |
+ | | role | Integer | 角色 |
+ | | enabled | Boolean | 是否启用 |
+ | | dateCreated | String | 创建时间 |
+ | | dateUpdated | String | 更新时间 |
+ | | token | String | token |
+ | | expiredTime | Long | 超时时间，单位：毫秒 |
+
+ **示例**
+
+ ```json
+ {
+ "code": 200,
+ "message": "login dashboard user success",
+ "data": {
+ "id": "1",
+ "userName": "admin",
+ "role": 1,
+ "enabled": true,
+ "dateCreated": "2022-09-07 22:08:23",
+ "dateUpdated": "2022-09-07 22:08:23",
+ "token":
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyTmFtZSI6ImFkbWluIiwiZXhwIjoxNjYyNjQ2MzU5fQ.WBXBgCcGsnnC00pRbDOtqCVoAaZr8MKH6WE6kY-NGaI",
+ "expiredTime": 86400000
+ }
+ }
+ ```
+
+## 注册服务
+
+- **请求方式**
+
+ `POST`
+
+- **请求路径**
+ - `http://{shenyu-admin}/shenyu-client/register-uri`
+ - 其中 `shenyu-admin` 表示为 `admin` 后台管理系统的 `ip + port`
+
+
+- **请求参数**
+
+ - `Header`参数
+
+ - `contentType: application/json`
+
+ - `X-Access-Token: {token}`，token 为调用登陆接口获取的 token
+
+ - `Body`参数，`json`类型
+
+ | 字段 | 类型 | 是否必填 | 描述
|
+ | ----------- | ------- | -------- |
------------------------------------------------------------ |
+ | protocol | String | 是 | 协议类型
|
+ | appName | String | 是 | 应用名称
|
+ | contextPath | String | 是 | 项目路径
|
+ | rpcType | String | 是 | rpc类型，支持的类型参考
[RpcTypeEnum](https://github.com/apache/shenyu/blob/v2.4.3/shenyu-common/src/main/java/org/apache/shenyu/common/enums/RpcTypeEnum.java)
|
+ | host | String | 是 | 客户端IP
|
+ | port | Integer | 是 | 客户端端口
|
+ | eventType | String | 是 | 事件类型，支持的类型参考
[EventType](https://github.com/apache/shenyu/blob/v2.4.3/shenyu-register-center/shenyu-register-common/src/main/java/org/apache/shenyu/register/common/enums/EventType.java)
|
+
+ **示例**
+
+ ```json
+ {
+ "protocol": "http",
+ "appName": "app",
+ "contextPath": "/test",
+ "rpcType": "http",
+ "host": "127.0.0.1",
+ "port": "8080",
+ "eventType": "REGISTER"
+ }
+ ```
+
+- **返回数据**
+
+ 注册成功会返回 `success`
+
+
+
+
+## 注册元数据
+
+- **请求方式**
+
+ `POST`
+
+- **请求路径**
+ - `http://{shenyu-admin}/shenyu-client/register-metadata`
+ - 其中 `shenyu-admin` 表示为 `admin` 后台管理系统的 `ip + port`
+
+- **请求参数**
+ - `Header`参数
+
+ - `contentType: application/json`
+
+ - `X-Access-Token: {token}`，token 为调用登陆接口获取的 token
+
+ - `Body`参数，`json`类型
+
+ | 字段 | 类型 | 是否必填 | 描述
|
+ | ---------------- | ------------ | -------- |
------------------------------------------------------------ |
+ | appName | String | 是 | 应用名称
|
+ | contextPath | String | 是 | 项目路径
|
+ | path | String | 是 | 路径
|
+ | pathDesc | String | 是 | 路径描述
|
+ | rpcType | String | 是 | rpc类型，支持的类型参考
[RpcTypeEnum](https://github.com/apache/shenyu/blob/v2.4.3/shenyu-common/src/main/java/org/apache/shenyu/common/enums/RpcTypeEnum.java)
|
+ | serviceName | String | 是 | 服务名称
|
+ | methodName | String | 是 | 方法名称
|
+ | ruleName | String | 是 | 规则名称
|
+ | parameterTypes | String | 是 | 参数类型
|
+ | rpcExt | String | 是 | Rpc拓展参数
|
+ | enabled | Boolean | 否 | 状态
|
+ | host | String | 是 | 服务 IP
|
+ | port | Integer | 是 | 服务端口
|
+ | pluginNames | List | 是 | 插件名称列表
|
+ | registerMetaData | Boolean | 否 | 是否注册元数据
|
+
+ **示例**
+
+ ```json
+ {
+ "appName": "app",
+ "contextPath": "/",
+ "path": "/test",
+ "rpcType": "http",
+ "serviceName": "测试服务",
+ "parameterTypes": "java.lang.String",
+ "pathDesc": "测试路径",
+ "methodName": "测试方法",
+ "ruleName": "测试规则",
+ "rpcExt": "{\"loadbalance\":\"hash\",\"retries\":3,\"timeout\":-1}",
+ "enabled": true,
+ "host": "127.0.0.1",
+ "port": 8080,
+ "pluginNames": [],
+ "registerMetaData": true
+ }
+ ```
+
+- **返回数据**
+
+ 注册成功会返回 `success`
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/version-2.5.0/developer/developer-shenyu-client.md
b/i18n/zh/docusaurus-plugin-content-docs/version-2.5.0/developer/developer-shenyu-client.md
index a98320316a..92dac21bf8 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/version-2.5.0/developer/developer-shenyu-client.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/version-2.5.0/developer/developer-shenyu-client.md
@@ -7,32 +7,178 @@ description: 多语言http客户端
## 说明
* 本文主要讲解其他语言的`http`服务如何接入网关。
-* 如何自定义开发`shenyu-http-client`。
+* 接入网关需要先获取 token, 然后可以根据需求调用注册服务或元数据接口
-## 自定义开发
-* 请求方式：`POST`
-* 请求路径：`http://shenyu-admin/shenyu-client/springmvc-register` ， 其中
`shenyu-admin` 表示为 `admin` 后台管理系统的 `ip + port` 。
+## 获取 token
-* 请求参数：`Apache ShenYu`网关默认的需要参数，通过`body`里面传入，`json`类型。
+- **请求方式**
-```json
-{
- "appName": "xxx", //应用名称 必填
- "context": "/xxx", //请求前缀 必填
- "path": "xxx", //路径需要唯一 必填
- "pathDesc": "xxx", //路径描述
- "rpcType": "http", //rpc类型 必填
- "host": "xxx", //服务host 必填
- "port": xxx, //服务端口 必填
- "ruleName": "xxx", //可以同path一样 必填
- "enabled": "true", //是否开启
- "registerMetaData": "true" //是否需要注册元数据
-}
-```
+ `GET`
+- **请求路径**
+ - `http://{shenyu-admin}/platform/login`
+ - 其中 `shenyu-admin` 表示为 `admin` 后台管理系统的 `ip + port`
+- **请求参数**
+
+ - `query`参数，账号密码为 admin 服务的用户名和密码
+
+ | 字段 | 类型 | 是否必填 | 描述 |
+ | -------- | ------ | -------- | ------ |
+ | userName | String | 是 | 用户名 |
+ | password | String | 是 | 密码 |
+
+- **返回数据**
+
+ | 字段 | | 类型 | 描述 |
+ | ------- | ----------- | ------- | -------------------- |
+ | code | | Integer | 返回码 |
+ | message | | String | 返回信息 |
+ | data | | Object | 返回对象 |
+ | | id | Integer | 用户id |
+ | | userName | String | 账号 |
+ | | role | Integer | 角色 |
+ | | enabled | Boolean | 是否启用 |
+ | | dateCreated | String | 创建时间 |
+ | | dateUpdated | String | 更新时间 |
+ | | token | String | token |
+ | | expiredTime | Long | 超时时间，单位：毫秒 |
+
+ **示例**
+
+ ```json
+ {
+ "code": 200,
+ "message": "login dashboard user success",
+ "data": {
+ "id": "1",
+ "userName": "admin",
+ "role": 1,
+ "enabled": true,
+ "dateCreated": "2022-09-07 22:08:23",
+ "dateUpdated": "2022-09-07 22:08:23",
+ "token":
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyTmFtZSI6ImFkbWluIiwiZXhwIjoxNjYyNjQ2MzU5fQ.WBXBgCcGsnnC00pRbDOtqCVoAaZr8MKH6WE6kY-NGaI",
+ "expiredTime": 86400000
+ }
+ }
+ ```
+
+## 注册服务
+
+- **请求方式**
+
+ `POST`
+
+- **请求路径**
+ - `http://{shenyu-admin}/shenyu-client/register-uri`
+ - 其中 `shenyu-admin` 表示为 `admin` 后台管理系统的 `ip + port`
+
+
+- **请求参数**
+
+ - `Header`参数
+
+ - `contentType: application/json`
+
+ - `X-Access-Token: {token}`，token 为调用登陆接口获取的 token
+
+ - `Body`参数，`json`类型
+
+ | 字段 | 类型 | 是否必填 | 描述
|
+ | ----------- | ------- | -------- |
------------------------------------------------------------ |
+ | protocol | String | 是 | 协议类型
|
+ | appName | String | 是 | 应用名称
|
+ | contextPath | String | 是 | 项目路径
|
+ | rpcType | String | 是 | rpc类型，支持的类型参考
[RpcTypeEnum](https://github.com/apache/shenyu/blob/v2.5.0/shenyu-common/src/main/java/org/apache/shenyu/common/enums/RpcTypeEnum.java)
|
+ | host | String | 是 | 客户端IP
|
+ | port | Integer | 是 | 客户端端口
|
+ | eventType | String | 是 | 事件类型，支持的类型参考
[EventType](https://github.com/apache/shenyu/blob/v2.5.0/shenyu-register-center/shenyu-register-common/src/main/java/org/apache/shenyu/register/common/enums/EventType.java)
|
+
+ **示例**
+
+ ```json
+ {
+ "protocol": "http",
+ "appName": "app",
+ "contextPath": "/test",
+ "rpcType": "http",
+ "host": "127.0.0.1",
+ "port": "8080",
+ "eventType": "REGISTER"
+ }
+ ```
+
+- **返回数据**
+
+ 注册成功会返回 `success`
+
+
+
+
+## 注册元数据
+
+- **请求方式**
+
+ `POST`
+
+- **请求路径**
+ - `http://{shenyu-admin}/shenyu-client/register-metadata`
+ - 其中 `shenyu-admin` 表示为 `admin` 后台管理系统的 `ip + port`
+
+- **请求参数**
+ - `Header`参数
+
+ - `contentType: application/json`
+
+ - `X-Access-Token: {token}`，token 为调用登陆接口获取的 token
+
+ - `Body`参数，`json`类型
+
+ | 字段 | 类型 | 是否必填 | 描述
|
+ | ---------------- | ------------ | -------- |
------------------------------------------------------------ |
+ | appName | String | 是 | 应用名称
|
+ | contextPath | String | 是 | 项目路径
|
+ | path | String | 是 | 路径
|
+ | pathDesc | String | 是 | 路径描述
|
+ | rpcType | String | 是 | rpc类型，支持的类型参考
[RpcTypeEnum](https://github.com/apache/shenyu/blob/v2.5.0/shenyu-common/src/main/java/org/apache/shenyu/common/enums/RpcTypeEnum.java)
|
+ | serviceName | String | 是 | 服务名称
|
+ | methodName | String | 是 | 方法名称
|
+ | ruleName | String | 是 | 规则名称
|
+ | parameterTypes | String | 是 | 参数类型
|
+ | rpcExt | String | 是 | Rpc拓展参数
|
+ | enabled | Boolean | 否 | 状态
|
+ | host | String | 是 | 服务 IP
|
+ | port | Integer | 是 | 服务端口
|
+ | pluginNames | List | 是 | 插件名称列表
|
+ | registerMetaData | Boolean | 否 | 是否注册元数据
|
+
+ **示例**
+
+ ```json
+ {
+ "appName": "app",
+ "contextPath": "/",
+ "path": "/test",
+ "rpcType": "http",
+ "serviceName": "测试服务",
+ "parameterTypes": "java.lang.String",
+ "pathDesc": "测试路径",
+ "methodName": "测试方法",
+ "ruleName": "测试规则",
+ "rpcExt": "{\"loadbalance\":\"hash\",\"retries\":3,\"timeout\":-1}",
+ "enabled": true,
+ "host": "127.0.0.1",
+ "port": 8080,
+ "pluginNames": [],
+ "registerMetaData": true
+ }
+ ```
+
+- **返回数据**
+
+ 注册成功会返回 `success`
diff --git a/versioned_docs/version-2.4.0/developer/developer-shenyu-client.md
b/versioned_docs/version-2.4.0/developer/developer-shenyu-client.md
index 5565402355..278e019343 100644
--- a/versioned_docs/version-2.4.0/developer/developer-shenyu-client.md
+++ b/versioned_docs/version-2.4.0/developer/developer-shenyu-client.md
@@ -7,29 +7,180 @@ description: A multilingual HTTP client
## Description
* This document focuses on how to access gateways for `HTTP` services in other
languages.
-* How to customize the development of `shenyu-http-client`.
-
-## Customize Http Client
-
-* Request Method: `POST`
-* Request Path: `http://soul-admin/soul-client/springmvc-register`,
shenyu-admin represents `IP + Port` of admin
-* Request Params：passing `JSON` type parameters through the body.
-
-```json
-{
- "appName": "xxx", //required
- "context": "/xxx", //required
- "path": "xxx", //required
- "pathDesc": "xxx",
- "rpcType": "http", //required
- "host": "xxx", //required
- "port": xxx, //required
- "ruleName": "xxx", //required
- "enabled": "true", //required
- "registerMetaData": "true" //required
-}
-```
+* To access the gateway, you need to get the token first, and then you can
call the registration service or metadata interface according to your needs.
+## Get token
+
+- **Request Method**
+
+ `GET`
+
+- **Request Path**
+ - `http://{shenyu-admin}/platform/login`
+ - Where `shenyu-admin` is the `ip + port` of the `admin` backend
management system.
+
+
+- **Request Params**
+
+ - `query` parameter, the account password is the username and password of
the admin service.
+
+ | Field | Type | Required | Desc |
+ | -------- | ------ | --------- | --------------------- |
+ | userName | String | Yes | shenyu admin account |
+ | password | String | Yes | shenyu admin password |
+
+
+- **Return Data**
+
+ | Field | | Type | Desc |
+ | ------- | ----------- | ------- | ----------------------------- |
+ | code | | Integer | Return code |
+ | message | | String | Return message |
+ | data | | Object | Return data |
+ | | id | Integer | user id |
+ | | userName | String | account |
+ | | role | Integer | role id |
+ | | enabled | Boolean | status |
+ | | dateCreated | String | create time |
+ | | dateUpdated | String | update time |
+ | | token | String | token |
+ | | expiredTime | Long | timeout time, in milliseconds |
+
+ **Example**
+
+ ```json
+ {
+ "code": 200,
+ "message": "login dashboard user success",
+ "data": {
+ "id": "1",
+ "userName": "admin",
+ "role": 1,
+ "enabled": true,
+ "dateCreated": "2022-09-07 22:08:23",
+ "dateUpdated": "2022-09-07 22:08:23",
+ "token":
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyTmFtZSI6ImFkbWluIiwiZXhwIjoxNjYyNjQ2MzU5fQ.WBXBgCcGsnnC00pRbDOtqCVoAaZr8MKH6WE6kY-NGaI",
+ "expiredTime": 86400000
+ }
+ }
+ ```
+
+
+
+## Registration Services
+
+- **Request Method**
+
+ `POST`
+
+- **Request Path**
+ - `http://{shenyu-admin}/shenyu-client/register-uri`
+ - Where `shenyu-admin` is the `ip + port` of the `admin` backend
management system.
+
+
+* **Request Params**
+
+ - `Header`
+
+ - `contentType: application/json`
+
+ - `X-Access-Token: {token}`，token is the token obtained by `Get token`.
+
+ - `Body`，`json` format
+
+ | Field | Type | Required | Desc
|
+ | ----------- | -------
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
------------------------------------------------------------ |
+ | protocol | String | Yes | protocol type
|
+ | appName | String | Yes | app name
|
+ | contextPath | String | Yes | service path
|
+ | rpcType | String | Yes | rpc type, supported type reference
[RpcTypeEnum](https://github.com/apache/shenyu/blob/v2.4.0/shenyu-common/src/main/java/org/apache/shenyu/common/enums/RpcTypeEnum.java)
|
+ | host | String | Yes | service IP
|
+ | port | Integer | Yes | service port
|
+ | eventType | String | Yes | event type, supported types
reference
[EventType](https://github.com/apache/shenyu/blob/v2.4.0/shenyu-register-center/shenyu-register-common/src/main/java/org/apache/shenyu/register/common/enums/EventType.java)
|
+
+ **Example**
+
+ ```json
+ {
+ "protocol": "http",
+ "appName": "app",
+ "contextPath": "/test",
+ "rpcType": "http",
+ "host": "127.0.0.1",
+ "port": "8080",
+ "eventType": "REGISTER"
+ }
+ ```
+
+- **Return Data**
+
+ A successful registration returns `success`.
+
+## Registration Metadata
+
+- **Request Method**
+
+ `POST`
+
+- **Request Path**
+
+ - `http://{shenyu-admin}/shenyu-client/register-metadata`
+ - Where `shenyu-admin` is the `ip + port` of the `admin` backend
management system.
+
+- **Request Params**
+
+ - `Header`
+
+ - `contentType: application/json`
+
+ - `X-Access-Token: {token}`，token is the token obtained by `Get token`.
+
+ - `Body`，`json` format.
+
+ | Field | Type | Required | Desc
|
+ | ---------------- | -------
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
------------------------------------------------------------ |
+ | appName | String | Yes | app name
|
+ | contextPath | String | Yes | service path
|
+ | path | String | Yes | path
|
+ | pathDesc | String | Yes | path description
|
+ | rpcType | String | Yes | rpc type, supported type
reference
[RpcTypeEnum](https://github.com/apache/shenyu/blob/v2.4.0/shenyu-common/src/main/java/org/apache/shenyu/common/enums/RpcTypeEnum.java)
|
+ | serviceName | String | Yes | service name
|
+ | methodName | String | Yes | method name
|
+ | ruleName | String | Yes | rule name
|
+ | parameterTypes | String | Yes | parameter Type
|
+ | rpcExt | String | Yes | rpc expansion parameters
|
+ | enabled | Boolean | No | status
|
+ | host | String | Yes | service IP
|
+ | port | Integer | Yes | service port
|
+ | pluginNames | List | No | plugin name list
|
+ | registerMetaData | Boolean | No | whether to register metadata
|
+
+ **examples**
+
+ ```json
+ {
+ "appName": "app",
+ "contextPath": "/",
+ "path": "/test",
+ "rpcType": "http",
+ "serviceName": "test service",
+ "parameterTypes": "java.lang.String",
+ "pathDesc": "test path",
+ "methodName": "test method",
+ "ruleName": "test rule",
+ "rpcExt": "{\"loadbalance\":\"hash\",\"retries\":3,\"timeout\":-1}",
+ "enabled": true,
+ "host": "127.0.0.1",
+ "port": 8080,
+ "pluginNames": [],
+ "registerMetaData": true
+ }
+ ```
+
+- **Return Data**
+
+ A successful registration returns `success`.
+
diff --git a/versioned_docs/version-2.4.1/developer/developer-shenyu-client.md
b/versioned_docs/version-2.4.1/developer/developer-shenyu-client.md
index 5565402355..f9cf0fbc33 100644
--- a/versioned_docs/version-2.4.1/developer/developer-shenyu-client.md
+++ b/versioned_docs/version-2.4.1/developer/developer-shenyu-client.md
@@ -7,29 +7,180 @@ description: A multilingual HTTP client
## Description
* This document focuses on how to access gateways for `HTTP` services in other
languages.
-* How to customize the development of `shenyu-http-client`.
-
-## Customize Http Client
-
-* Request Method: `POST`
-* Request Path: `http://soul-admin/soul-client/springmvc-register`,
shenyu-admin represents `IP + Port` of admin
-* Request Params：passing `JSON` type parameters through the body.
-
-```json
-{
- "appName": "xxx", //required
- "context": "/xxx", //required
- "path": "xxx", //required
- "pathDesc": "xxx",
- "rpcType": "http", //required
- "host": "xxx", //required
- "port": xxx, //required
- "ruleName": "xxx", //required
- "enabled": "true", //required
- "registerMetaData": "true" //required
-}
-```
+* To access the gateway, you need to get the token first, and then you can
call the registration service or metadata interface according to your needs.
+## Get token
+
+- **Request Method**
+
+ `GET`
+
+- **Request Path**
+ - `http://{shenyu-admin}/platform/login`
+ - Where `shenyu-admin` is the `ip + port` of the `admin` backend
management system.
+
+
+- **Request Params**
+
+ - `query` parameter, the account password is the username and password of
the admin service.
+
+ | Field | Type | Required | Desc |
+ | -------- | ------ | --------- | --------------------- |
+ | userName | String | Yes | shenyu admin account |
+ | password | String | Yes | shenyu admin password |
+
+
+- **Return Data**
+
+ | Field | | Type | Desc |
+ | ------- | ----------- | ------- | ----------------------------- |
+ | code | | Integer | Return code |
+ | message | | String | Return message |
+ | data | | Object | Return data |
+ | | id | Integer | user id |
+ | | userName | String | account |
+ | | role | Integer | role id |
+ | | enabled | Boolean | status |
+ | | dateCreated | String | create time |
+ | | dateUpdated | String | update time |
+ | | token | String | token |
+ | | expiredTime | Long | timeout time, in milliseconds |
+
+ **Example**
+
+ ```json
+ {
+ "code": 200,
+ "message": "login dashboard user success",
+ "data": {
+ "id": "1",
+ "userName": "admin",
+ "role": 1,
+ "enabled": true,
+ "dateCreated": "2022-09-07 22:08:23",
+ "dateUpdated": "2022-09-07 22:08:23",
+ "token":
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyTmFtZSI6ImFkbWluIiwiZXhwIjoxNjYyNjQ2MzU5fQ.WBXBgCcGsnnC00pRbDOtqCVoAaZr8MKH6WE6kY-NGaI",
+ "expiredTime": 86400000
+ }
+ }
+ ```
+
+
+
+## Registration Services
+
+- **Request Method**
+
+ `POST`
+
+- **Request Path**
+ - `http://{shenyu-admin}/shenyu-client/register-uri`
+ - Where `shenyu-admin` is the `ip + port` of the `admin` backend
management system.
+
+
+* **Request Params**
+
+ - `Header`
+
+ - `contentType: application/json`
+
+ - `X-Access-Token: {token}`，token is the token obtained by `Get token`.
+
+ - `Body`，`json` format
+
+ | Field | Type | Required | Desc
|
+ | ----------- | -------
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
------------------------------------------------------------ |
+ | protocol | String | Yes | protocol type
|
+ | appName | String | Yes | app name
|
+ | contextPath | String | Yes | service path
|
+ | rpcType | String | Yes | rpc type, supported type reference
[RpcTypeEnum](https://github.com/apache/shenyu/blob/v2.4.1/shenyu-common/src/main/java/org/apache/shenyu/common/enums/RpcTypeEnum.java)
|
+ | host | String | Yes | service IP
|
+ | port | Integer | Yes | service port
|
+ | eventType | String | Yes | event type, supported types
reference
[EventType](https://github.com/apache/shenyu/blob/v2.4.1/shenyu-register-center/shenyu-register-common/src/main/java/org/apache/shenyu/register/common/enums/EventType.java)
|
+
+ **Example**
+
+ ```json
+ {
+ "protocol": "http",
+ "appName": "app",
+ "contextPath": "/test",
+ "rpcType": "http",
+ "host": "127.0.0.1",
+ "port": "8080",
+ "eventType": "REGISTER"
+ }
+ ```
+
+- **Return Data**
+
+ A successful registration returns `success`.
+
+## Registration Metadata
+
+- **Request Method**
+
+ `POST`
+
+- **Request Path**
+
+ - `http://{shenyu-admin}/shenyu-client/register-metadata`
+ - Where `shenyu-admin` is the `ip + port` of the `admin` backend
management system.
+
+- **Request Params**
+
+ - `Header`
+
+ - `contentType: application/json`
+
+ - `X-Access-Token: {token}`，token is the token obtained by `Get token`.
+
+ - `Body`，`json` format.
+
+ | Field | Type | Required | Desc
|
+ | ---------------- | -------
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
------------------------------------------------------------ |
+ | appName | String | Yes | app name
|
+ | contextPath | String | Yes | service path
|
+ | path | String | Yes | path
|
+ | pathDesc | String | Yes | path description
|
+ | rpcType | String | Yes | rpc type, supported type
reference
[RpcTypeEnum](https://github.com/apache/shenyu/blob/v2.4.1/shenyu-common/src/main/java/org/apache/shenyu/common/enums/RpcTypeEnum.java)
|
+ | serviceName | String | Yes | service name
|
+ | methodName | String | Yes | method name
|
+ | ruleName | String | Yes | rule name
|
+ | parameterTypes | String | Yes | parameter Type
|
+ | rpcExt | String | Yes | rpc expansion parameters
|
+ | enabled | Boolean | No | status
|
+ | host | String | Yes | service IP
|
+ | port | Integer | Yes | service port
|
+ | pluginNames | List | No | plugin name list
|
+ | registerMetaData | Boolean | No | whether to register metadata
|
+
+ **examples**
+
+ ```json
+ {
+ "appName": "app",
+ "contextPath": "/",
+ "path": "/test",
+ "rpcType": "http",
+ "serviceName": "test service",
+ "parameterTypes": "java.lang.String",
+ "pathDesc": "test path",
+ "methodName": "test method",
+ "ruleName": "test rule",
+ "rpcExt": "{\"loadbalance\":\"hash\",\"retries\":3,\"timeout\":-1}",
+ "enabled": true,
+ "host": "127.0.0.1",
+ "port": 8080,
+ "pluginNames": [],
+ "registerMetaData": true
+ }
+ ```
+
+- **Return Data**
+
+ A successful registration returns `success`.
+
diff --git a/versioned_docs/version-2.4.2/developer/developer-shenyu-client.md
b/versioned_docs/version-2.4.2/developer/developer-shenyu-client.md
index 5565402355..5ca62e987a 100644
--- a/versioned_docs/version-2.4.2/developer/developer-shenyu-client.md
+++ b/versioned_docs/version-2.4.2/developer/developer-shenyu-client.md
@@ -7,29 +7,179 @@ description: A multilingual HTTP client
## Description
* This document focuses on how to access gateways for `HTTP` services in other
languages.
-* How to customize the development of `shenyu-http-client`.
-
-## Customize Http Client
-
-* Request Method: `POST`
-* Request Path: `http://soul-admin/soul-client/springmvc-register`,
shenyu-admin represents `IP + Port` of admin
-* Request Params：passing `JSON` type parameters through the body.
-
-```json
-{
- "appName": "xxx", //required
- "context": "/xxx", //required
- "path": "xxx", //required
- "pathDesc": "xxx",
- "rpcType": "http", //required
- "host": "xxx", //required
- "port": xxx, //required
- "ruleName": "xxx", //required
- "enabled": "true", //required
- "registerMetaData": "true" //required
-}
-```
+* To access the gateway, you need to get the token first, and then you can
call the registration service or metadata interface according to your needs.
+## Get token
+
+- **Request Method**
+
+ `GET`
+
+- **Request Path**
+ - `http://{shenyu-admin}/platform/login`
+ - Where `shenyu-admin` is the `ip + port` of the `admin` backend
management system.
+
+
+- **Request Params**
+
+ - `query` parameter, the account password is the username and password of
the admin service.
+
+ | Field | Type | Required | Desc |
+ | -------- | ------ | --------- | --------------------- |
+ | userName | String | Yes | shenyu admin account |
+ | password | String | Yes | shenyu admin password |
+
+- **Return Data**
+
+ | Field | | Type | Desc |
+ | ------- | ----------- | ------- | ----------------------------- |
+ | code | | Integer | Return code |
+ | message | | String | Return message |
+ | data | | Object | Return data |
+ | | id | Integer | user id |
+ | | userName | String | account |
+ | | role | Integer | role id |
+ | | enabled | Boolean | status |
+ | | dateCreated | String | create time |
+ | | dateUpdated | String | update time |
+ | | token | String | token |
+ | | expiredTime | Long | timeout time, in milliseconds |
+
+ **Example**
+
+ ```json
+ {
+ "code": 200,
+ "message": "login dashboard user success",
+ "data": {
+ "id": "1",
+ "userName": "admin",
+ "role": 1,
+ "enabled": true,
+ "dateCreated": "2022-09-07 22:08:23",
+ "dateUpdated": "2022-09-07 22:08:23",
+ "token":
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyTmFtZSI6ImFkbWluIiwiZXhwIjoxNjYyNjQ2MzU5fQ.WBXBgCcGsnnC00pRbDOtqCVoAaZr8MKH6WE6kY-NGaI",
+ "expiredTime": 86400000
+ }
+ }
+ ```
+
+
+
+## Registration Services
+
+- **Request Method**
+
+ `POST`
+
+- **Request Path**
+ - `http://{shenyu-admin}/shenyu-client/register-uri`
+ - Where `shenyu-admin` is the `ip + port` of the `admin` backend
management system.
+
+
+* **Request Params**
+
+ - `Header`
+
+ - `contentType: application/json`
+
+ - `X-Access-Token: {token}`，token is the token obtained by `Get token`.
+
+ - `Body`，`json` format
+
+ | Field | Type | Required | Desc
|
+ | ----------- | -------
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
------------------------------------------------------------ |
+ | protocol | String | Yes | protocol type
|
+ | appName | String | Yes | app name
|
+ | contextPath | String | Yes | service path
|
+ | rpcType | String | Yes | rpc type, supported type reference
[RpcTypeEnum](https://github.com/apache/shenyu/blob/v2.4.2/shenyu-common/src/main/java/org/apache/shenyu/common/enums/RpcTypeEnum.java)
|
+ | host | String | Yes | service IP
|
+ | port | Integer | Yes | service port
|
+ | eventType | String | Yes | event type, supported types
reference
[EventType](https://github.com/apache/shenyu/blob/v2.4.2/shenyu-register-center/shenyu-register-common/src/main/java/org/apache/shenyu/register/common/enums/EventType.java)
|
+
+ **Example**
+
+ ```json
+ {
+ "protocol": "http",
+ "appName": "app",
+ "contextPath": "/test",
+ "rpcType": "http",
+ "host": "127.0.0.1",
+ "port": "8080",
+ "eventType": "REGISTER"
+ }
+ ```
+
+- **Return Data**
+
+ A successful registration returns `success`.
+
+## Registration Metadata
+
+- **Request Method**
+
+ `POST`
+
+- **Request Path**
+
+ - `http://{shenyu-admin}/shenyu-client/register-metadata`
+ - Where `shenyu-admin` is the `ip + port` of the `admin` backend
management system.
+
+- **Request Params**
+
+ - `Header`
+
+ - `contentType: application/json`
+
+ - `X-Access-Token: {token}`，token is the token obtained by `Get token`.
+
+ - `Body`，`json` format.
+
+ | Field | Type | Required | Desc
|
+ | ---------------- | -------
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
------------------------------------------------------------ |
+ | appName | String | Yes | app name
|
+ | contextPath | String | Yes | service path
|
+ | path | String | Yes | path
|
+ | pathDesc | String | Yes | path description
|
+ | rpcType | String | Yes | rpc type, supported type
reference
[RpcTypeEnum](https://github.com/apache/shenyu/blob/v2.4.2/shenyu-common/src/main/java/org/apache/shenyu/common/enums/RpcTypeEnum.java)
|
+ | serviceName | String | Yes | service name
|
+ | methodName | String | Yes | method name
|
+ | ruleName | String | Yes | rule name
|
+ | parameterTypes | String | Yes | parameter Type
|
+ | rpcExt | String | Yes | rpc expansion parameters
|
+ | enabled | Boolean | No | status
|
+ | host | String | Yes | service IP
|
+ | port | Integer | Yes | service port
|
+ | pluginNames | List | No | plugin name list
|
+ | registerMetaData | Boolean | No | whether to register metadata
|
+
+ **examples**
+
+ ```json
+ {
+ "appName": "app",
+ "contextPath": "/",
+ "path": "/test",
+ "rpcType": "http",
+ "serviceName": "test service",
+ "parameterTypes": "java.lang.String",
+ "pathDesc": "test path",
+ "methodName": "test method",
+ "ruleName": "test rule",
+ "rpcExt": "{\"loadbalance\":\"hash\",\"retries\":3,\"timeout\":-1}",
+ "enabled": true,
+ "host": "127.0.0.1",
+ "port": 8080,
+ "pluginNames": [],
+ "registerMetaData": true
+ }
+ ```
+
+- **Return Data**
+
+ A successful registration returns `success`.
+
diff --git a/versioned_docs/version-2.4.3/developer/developer-shenyu-client.md
b/versioned_docs/version-2.4.3/developer/developer-shenyu-client.md
index 5565402355..bd483be153 100644
--- a/versioned_docs/version-2.4.3/developer/developer-shenyu-client.md
+++ b/versioned_docs/version-2.4.3/developer/developer-shenyu-client.md
@@ -7,29 +7,179 @@ description: A multilingual HTTP client
## Description
* This document focuses on how to access gateways for `HTTP` services in other
languages.
-* How to customize the development of `shenyu-http-client`.
-
-## Customize Http Client
-
-* Request Method: `POST`
-* Request Path: `http://soul-admin/soul-client/springmvc-register`,
shenyu-admin represents `IP + Port` of admin
-* Request Params：passing `JSON` type parameters through the body.
-
-```json
-{
- "appName": "xxx", //required
- "context": "/xxx", //required
- "path": "xxx", //required
- "pathDesc": "xxx",
- "rpcType": "http", //required
- "host": "xxx", //required
- "port": xxx, //required
- "ruleName": "xxx", //required
- "enabled": "true", //required
- "registerMetaData": "true" //required
-}
-```
+* To access the gateway, you need to get the token first, and then you can
call the registration service or metadata interface according to your needs.
+## Get token
+
+- **Request Method**
+
+ `GET`
+
+- **Request Path**
+ - `http://{shenyu-admin}/platform/login`
+ - Where `shenyu-admin` is the `ip + port` of the `admin` backend
management system.
+
+
+- **Request Params**
+
+ - `query` parameter, the account password is the username and password of
the admin service.
+
+ | Field | Type | Required | Desc |
+ | -------- | ------ | --------- | --------------------- |
+ | userName | String | Yes | shenyu admin account |
+ | password | String | Yes | shenyu admin password |
+
+- **Return Data**
+
+ | Field | | Type | Desc |
+ | ------- | ----------- | ------- | ----------------------------- |
+ | code | | Integer | Return code |
+ | message | | String | Return message |
+ | data | | Object | Return data |
+ | | id | Integer | user id |
+ | | userName | String | account |
+ | | role | Integer | role id |
+ | | enabled | Boolean | status |
+ | | dateCreated | String | create time |
+ | | dateUpdated | String | update time |
+ | | token | String | token |
+ | | expiredTime | Long | timeout time, in milliseconds |
+
+ **Example**
+
+ ```json
+ {
+ "code": 200,
+ "message": "login dashboard user success",
+ "data": {
+ "id": "1",
+ "userName": "admin",
+ "role": 1,
+ "enabled": true,
+ "dateCreated": "2022-09-07 22:08:23",
+ "dateUpdated": "2022-09-07 22:08:23",
+ "token":
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyTmFtZSI6ImFkbWluIiwiZXhwIjoxNjYyNjQ2MzU5fQ.WBXBgCcGsnnC00pRbDOtqCVoAaZr8MKH6WE6kY-NGaI",
+ "expiredTime": 86400000
+ }
+ }
+ ```
+
+
+
+## Registration Services
+
+- **Request Method**
+
+ `POST`
+
+- **Request Path**
+ - `http://{shenyu-admin}/shenyu-client/register-uri`
+ - Where `shenyu-admin` is the `ip + port` of the `admin` backend
management system.
+
+
+* **Request Params**
+
+ - `Header`
+
+ - `contentType: application/json`
+
+ - `X-Access-Token: {token}`，token is the token obtained by `Get token`.
+
+ - `Body`，`json` format
+
+ | Field | Type | Required | Desc
|
+ | ----------- | -------
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
------------------------------------------------------------ |
+ | protocol | String | Yes | protocol type
|
+ | appName | String | Yes | app name
|
+ | contextPath | String | Yes | service path
|
+ | rpcType | String | Yes | rpc type, supported type reference
[RpcTypeEnum](https://github.com/apache/shenyu/blob/v2.4.3/shenyu-common/src/main/java/org/apache/shenyu/common/enums/RpcTypeEnum.java)
|
+ | host | String | Yes | service IP
|
+ | port | Integer | Yes | service port
|
+ | eventType | String | Yes | event type, supported types
reference
[EventType](https://github.com/apache/shenyu/blob/v2.4.3/shenyu-register-center/shenyu-register-common/src/main/java/org/apache/shenyu/register/common/enums/EventType.java)
|
+
+ **Example**
+
+ ```json
+ {
+ "protocol": "http",
+ "appName": "app",
+ "contextPath": "/test",
+ "rpcType": "http",
+ "host": "127.0.0.1",
+ "port": "8080",
+ "eventType": "REGISTER"
+ }
+ ```
+
+- **Return Data**
+
+ A successful registration returns `success`.
+
+## Registration Metadata
+
+- **Request Method**
+
+ `POST`
+
+- **Request Path**
+
+ - `http://{shenyu-admin}/shenyu-client/register-metadata`
+ - Where `shenyu-admin` is the `ip + port` of the `admin` backend
management system.
+
+- **Request Params**
+
+ - `Header`
+
+ - `contentType: application/json`
+
+ - `X-Access-Token: {token}`，token is the token obtained by `Get token`.
+
+ - `Body`，`json` format.
+
+ | Field | Type | Required | Desc
|
+ | ---------------- | -------
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
------------------------------------------------------------ |
+ | appName | String | Yes | app name
|
+ | contextPath | String | Yes | service path
|
+ | path | String | Yes | path
|
+ | pathDesc | String | Yes | path description
|
+ | rpcType | String | Yes | rpc type, supported type
reference
[RpcTypeEnum](https://github.com/apache/shenyu/blob/v2.4.3/shenyu-common/src/main/java/org/apache/shenyu/common/enums/RpcTypeEnum.java)
|
+ | serviceName | String | Yes | service name
|
+ | methodName | String | Yes | method name
|
+ | ruleName | String | Yes | rule name
|
+ | parameterTypes | String | Yes | parameter Type
|
+ | rpcExt | String | Yes | rpc expansion parameters
|
+ | enabled | Boolean | No | status
|
+ | host | String | Yes | service IP
|
+ | port | Integer | Yes | service port
|
+ | pluginNames | List | No | plugin name list
|
+ | registerMetaData | Boolean | No | whether to register metadata
|
+
+ **examples**
+
+ ```json
+ {
+ "appName": "app",
+ "contextPath": "/",
+ "path": "/test",
+ "rpcType": "http",
+ "serviceName": "test service",
+ "parameterTypes": "java.lang.String",
+ "pathDesc": "test path",
+ "methodName": "test method",
+ "ruleName": "test rule",
+ "rpcExt": "{\"loadbalance\":\"hash\",\"retries\":3,\"timeout\":-1}",
+ "enabled": true,
+ "host": "127.0.0.1",
+ "port": 8080,
+ "pluginNames": [],
+ "registerMetaData": true
+ }
+ ```
+
+- **Return Data**
+
+ A successful registration returns `success`.
+
diff --git a/versioned_docs/version-2.5.0/developer/developer-shenyu-client.md
b/versioned_docs/version-2.5.0/developer/developer-shenyu-client.md
index 5565402355..da8d29c59a 100644
--- a/versioned_docs/version-2.5.0/developer/developer-shenyu-client.md
+++ b/versioned_docs/version-2.5.0/developer/developer-shenyu-client.md
@@ -7,29 +7,179 @@ description: A multilingual HTTP client
## Description
* This document focuses on how to access gateways for `HTTP` services in other
languages.
-* How to customize the development of `shenyu-http-client`.
-
-## Customize Http Client
-
-* Request Method: `POST`
-* Request Path: `http://soul-admin/soul-client/springmvc-register`,
shenyu-admin represents `IP + Port` of admin
-* Request Params：passing `JSON` type parameters through the body.
-
-```json
-{
- "appName": "xxx", //required
- "context": "/xxx", //required
- "path": "xxx", //required
- "pathDesc": "xxx",
- "rpcType": "http", //required
- "host": "xxx", //required
- "port": xxx, //required
- "ruleName": "xxx", //required
- "enabled": "true", //required
- "registerMetaData": "true" //required
-}
-```
+* To access the gateway, you need to get the token first, and then you can
call the registration service or metadata interface according to your needs.
+## Get token
+
+- **Request Method**
+
+ `GET`
+
+- **Request Path**
+ - `http://{shenyu-admin}/platform/login`
+ - Where `shenyu-admin` is the `ip + port` of the `admin` backend
management system.
+
+
+- **Request Params**
+
+ - `query` parameter, the account password is the username and password of
the admin service.
+
+ | Field | Type | Required | Desc |
+ | -------- | ------ | --------- | --------------------- |
+ | userName | String | Yes | shenyu admin account |
+ | password | String | Yes | shenyu admin password |
+
+- **Return Data**
+
+ | Field | | Type | Desc |
+ | ------- | ----------- | ------- | ----------------------------- |
+ | code | | Integer | Return code |
+ | message | | String | Return message |
+ | data | | Object | Return data |
+ | | id | Integer | user id |
+ | | userName | String | account |
+ | | role | Integer | role id |
+ | | enabled | Boolean | status |
+ | | dateCreated | String | create time |
+ | | dateUpdated | String | update time |
+ | | token | String | token |
+ | | expiredTime | Long | timeout time, in milliseconds |
+
+ **Example**
+
+ ```json
+ {
+ "code": 200,
+ "message": "login dashboard user success",
+ "data": {
+ "id": "1",
+ "userName": "admin",
+ "role": 1,
+ "enabled": true,
+ "dateCreated": "2022-09-07 22:08:23",
+ "dateUpdated": "2022-09-07 22:08:23",
+ "token":
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyTmFtZSI6ImFkbWluIiwiZXhwIjoxNjYyNjQ2MzU5fQ.WBXBgCcGsnnC00pRbDOtqCVoAaZr8MKH6WE6kY-NGaI",
+ "expiredTime": 86400000
+ }
+ }
+ ```
+
+
+
+## Registration Services
+
+- **Request Method**
+
+ `POST`
+
+- **Request Path**
+ - `http://{shenyu-admin}/shenyu-client/register-uri`
+ - Where `shenyu-admin` is the `ip + port` of the `admin` backend
management system.
+
+
+* **Request Params**
+
+ - `Header`
+
+ - `contentType: application/json`
+
+ - `X-Access-Token: {token}`，token is the token obtained by `Get token`.
+
+ - `Body`，`json` format
+
+ | Field | Type | Required | Desc
|
+ | ----------- | -------
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
------------------------------------------------------------ |
+ | protocol | String | Yes | protocol type
|
+ | appName | String | Yes | app name
|
+ | contextPath | String | Yes | service path
|
+ | rpcType | String | Yes | rpc type, supported type reference
[RpcTypeEnum](https://github.com/apache/shenyu/blob/v2.5.0/shenyu-common/src/main/java/org/apache/shenyu/common/enums/RpcTypeEnum.java)
|
+ | host | String | Yes | service IP
|
+ | port | Integer | Yes | service port
|
+ | eventType | String | Yes | event type, supported types
reference
[EventType](https://github.com/apache/shenyu/blob/v2.5.0/shenyu-register-center/shenyu-register-common/src/main/java/org/apache/shenyu/register/common/enums/EventType.java)
|
+
+ **Example**
+
+ ```json
+ {
+ "protocol": "http",
+ "appName": "app",
+ "contextPath": "/test",
+ "rpcType": "http",
+ "host": "127.0.0.1",
+ "port": "8080",
+ "eventType": "REGISTER"
+ }
+ ```
+
+- **Return Data**
+
+ A successful registration returns `success`.
+
+## Registration Metadata
+
+- **Request Method**
+
+ `POST`
+
+- **Request Path**
+
+ - `http://{shenyu-admin}/shenyu-client/register-metadata`
+ - Where `shenyu-admin` is the `ip + port` of the `admin` backend
management system.
+
+- **Request Params**
+
+ - `Header`
+
+ - `contentType: application/json`
+
+ - `X-Access-Token: {token}`，token is the token obtained by `Get token`.
+
+ - `Body`，`json` format.
+
+ | Field | Type | Required | Desc
|
+ | ---------------- | -------
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
------------------------------------------------------------ |
+ | appName | String | Yes | app name
|
+ | contextPath | String | Yes | service path
|
+ | path | String | Yes | path
|
+ | pathDesc | String | Yes | path description
|
+ | rpcType | String | Yes | rpc type, supported type
reference
[RpcTypeEnum](https://github.com/apache/shenyu/blob/v2.5.0/shenyu-common/src/main/java/org/apache/shenyu/common/enums/RpcTypeEnum.java)
|
+ | serviceName | String | Yes | service name
|
+ | methodName | String | Yes | method name
|
+ | ruleName | String | Yes | rule name
|
+ | parameterTypes | String | Yes | parameter Type
|
+ | rpcExt | String | Yes | rpc expansion parameters
|
+ | enabled | Boolean | No | status
|
+ | host | String | Yes | service IP
|
+ | port | Integer | Yes | service port
|
+ | pluginNames | List | No | plugin name list
|
+ | registerMetaData | Boolean | No | whether to register metadata
|
+
+ **examples**
+
+ ```json
+ {
+ "appName": "app",
+ "contextPath": "/",
+ "path": "/test",
+ "rpcType": "http",
+ "serviceName": "test service",
+ "parameterTypes": "java.lang.String",
+ "pathDesc": "test path",
+ "methodName": "test method",
+ "ruleName": "test rule",
+ "rpcExt": "{\"loadbalance\":\"hash\",\"retries\":3,\"timeout\":-1}",
+ "enabled": true,
+ "host": "127.0.0.1",
+ "port": 8080,
+ "pluginNames": [],
+ "registerMetaData": true
+ }
+ ```
+
+- **Return Data**
+
+ A successful registration returns `success`.
+
