Merge pull request #544 from WeBankBlockchain/dev

merge community articles into master

.readthedocs.yaml

@@ -0,0 +1,22 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.7"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: ./conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+  - requirements: ./requirements.txt

conf.py

@@ -100,7 +100,7 @@
 
 # General information about the project.
 project = u'WeBASE'
-copyright = u'© 2020. All rights reserved.'
+copyright = u'© 2023. All rights reserved.'
 author = u'WeBankBlockchain'
 
 # The version info for the project you're documenting, acts as replacement for

docs/WeBASE-APP-SDK/api.md

@@ -417,7 +417,7 @@ http://127.0.0.1:5001/WeBASE-Node-Manager/api/passwordUpdate?timestamp=161492885
 #### 传输协议规范
 
 * 网络传输协议：使用HTTP协议
-* 请求地址： **/api/basicInfo?appKey={appKey}&signature={signature}&timestamp={timestamp}**
+* 请求地址： **/api/basicInfo?appKey={appKey}&signature={signature}&timestamp={timestamp}&groupId={groupId}**
 * 请求方式：GET
 * 请求头：Content-type: application/json
 * 返回格式：JSON
@@ -426,10 +426,17 @@ http://127.0.0.1:5001/WeBASE-Node-Manager/api/passwordUpdate?timestamp=161492885
 
 ***1）入参表***
 
+| 序号 | 输入参数      | 类型   | 可为空 | 备注             |
+| ---- | ------------- | ------ | ------ | ---------------- |
+| 1    | appKey       | String | 否     | app接入的key             |
+| 2    | signature | String | 否     | 签名密文值 |
+| 3    | timestamp | String | 否     | 时间戳 |
+| 4    | groupId | String | 是     | FISCO BCOS为2.x版本则可为空，**3.x版本不可以为空** |
+
 ***2）入参示例***
 
 ```
-http://localhost:5001/WeBASE-Node-Manager/api/basicInfo?timestamp=1614928857832&appKey=fdsf78aW&signature=EEFD7CD030E6B311AA85B053A90E8A31
+http://localhost:5001/WeBASE-Node-Manager/api/basicInfo?timestamp=1614928857832&appKey=fdsf78aW&signature=EEFD7CD030E6B311AA85B053A90E8A31&groupId=1
 ```
 
 

docs/WeBASE-APP-SDK/appintegration.md

@@ -14,6 +14,7 @@ WeBASE-APP-SDK是应用集成SDK，提供调用WeBASE-Node-Manager的接口，
 
 - `v1.5.1`及其以上版本，应用配置AppConfig的属性`isTransferEncrypt`需和WeBASE-Node-Manager的配置文件`/conf/application.yml`下的配置`constant.isTransferEncrypt`相同，默认为`true`。
 - 如果`v1.5.0`需要使用SDK，应用配置AppConfig的属性`isTransferEncrypt`需设置为`false`。`v1.5.1`及其以上版本新增的接口调用不了。
+- `1.5.6`版本以上版本，既支持WeBASE 1.5.x及以上版本，同时支持WeBASE 3.1.0及以上版本（暂不支持WeBASE 3.0.2版本）
 
 ### 添加依赖
 
@@ -24,18 +25,20 @@ repositories {
     maven { url "http://maven.aliyun.com/nexus/content/groups/public/" }
 }
 dependencies {
-    implementation 'com.webank:webase-app-sdk:1.5.1'
+    implementation 'com.webank:webase-app-sdk:1.5.6-SNAPSHOT'
     implementation 'org.bouncycastle:bcprov-jdk15on:1.67'
     implementation 'org.apache.commons:commons-lang3:3.8.1'
     implementation 'com.squareup.okhttp3:okhttp:4.8.1'
-    implementation 'com.fasterxml.jackson.core:jackson-databind:2.11.0'
-    implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.11.0'
-    implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.11.0'
-    implementation 'com.fasterxml.jackson.module:jackson-module-parameter-names:2.11.0'
+    implementation 'com.fasterxml.jackson.core:jackson-databind:2.14.2'
+    implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.14.2'
+    implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.14.2'
+    implementation 'com.fasterxml.jackson.module:jackson-module-parameter-names:2.14.2'
     implementation 'org.projectlombok:lombok:1.18.12'
-    implementation 'org.apache.logging.log4j:log4j-api:2.13.3'
-    implementation 'org.apache.logging.log4j:log4j-core:2.13.3'
-    implementation 'org.apache.logging.log4j:log4j-slf4j-impl:2.13.3'
+    annotationProcessor 'org.projectlombok:lombok:1.18.12'
+    implementation 'org.apache.logging.log4j:log4j-api:2.20.0'
+    implementation 'org.apache.logging.log4j:log4j-core:2.20.0'
+    implementation 'org.apache.logging.log4j:log4j-slf4j-impl:2.20.0'
+    implementation 'org.slf4j:slf4j-api:1.7.36'
 }
 ```