doc(使用说明): 增加没有网络环境和没有maven环境的使用方法说明

This commit is contained in:
lqyan
2025-02-19 18:40:21 +08:00
parent 58209849dc
commit 9ae5d9acd2

View File

@@ -16,7 +16,7 @@
1. JH_Appform_6.0_Release
2. JH_Appform_6.0_SP1_Release
3. JH_Appform_6.1_Release
3. JH_Appform_6.2_Release6.2以前用1.x.x版本
4. JH_Appform_6.2_Release使用: release-2.0.3
# 2. 快速开始
@@ -26,7 +26,7 @@
建议在您的项目中使用 Jhinno OpenAPI SDK for Java 的方法是从 Maven 中使用它。:
#### 方法一通过命令将jar包导入本地Maven仓库(无网络开发额外配置)
#### 方法一:通过命令将 jar 包导入本地 Maven 仓库
```shell
@@ -42,12 +42,13 @@ mvn org.apache.maven.plugins:maven-install-plugin:3.1.1:install-file -Dfile="E:/
```
> 注:
>
> - jhinno-openapi-java-sdk-x.x.x.jar 为 SDK 的 jar 包。
> - jhinno-openapi-java-sdk-x.x.x-sources.jar 为源码包,添加可方便查看 SDK 代码的注释。
> - jhinno-openapi-sdk-spring-boot-starter-x.x.x.jar 为 SDK 的 spring-boot-starter 的 jar 包。
> - jhinno-openapi-sdk-spring-boot-starter-x.x.x-sources.jar 为 SDK 的 spring-boot-starter 的源码包。
#### 方法二:通过源码导入(无网络开发额外配置)
#### 方法二:通过源码导入
```shell
git clone https://github.com/yanlongqi/jhinno-openapi-java-sdk.git
@@ -66,6 +67,11 @@ mvn clean install
</dependency>
```
#### 方法三:直接使用 jar 包
如果开发环境没有网络,或者没有使用 maven 的构建工具,则可以使用 jar 包的方式导入。下载`dependency-jar.zip``jhinno-openapi-java-sdk-2.0.3-sources.jar``jhinno-openapi-java-sdk-2.0.3.jar`导入到你的 java 项目的 lib 里面。如果你的项目是 SpringBoot 项目,则还需要导入`jhinno-openapi-sdk-spring-boot-starter-2.0.3.jar``jhinno-openapi-sdk-spring-boot-starter-2.0.3-sources.jar
`这两个 jar 包。
### 2.1.3 配置
在 SpringBoot 的`application.properties``application.yml`里面配置
@@ -92,9 +98,12 @@ jhinno.openapi.auth-type=access_secret_mode
```
> 注:
>
> - 其中`jhinno.openapi.server-url`为景行接口服务的 BaseUrl
> - `auth-type` 认证类型,`token_mode`(Token 认证) 和 `access_secret_mode`AccessKey 认证Appform Release 6.2 `token_mode`
作为过渡,将会弃用;
> - `jhinno.openapi.used-server-time`是否获取服务器时间来请求 token关闭可提高获取 token 的时间,但打开有可能因为服务器时间不准确而导致 token 获取失败的问题。
> - `access-key` 和 `access-key-secret` 作为访问接口的凭证,需要提供集成商名称、系统名称、负责人姓名、负责电话电话信息申请。
> - 更多配置见`com.jhinno.sdk.openapi.autoconfigure.JHOpenapiProperties`源码。
@@ -140,6 +149,7 @@ mvn org.apache.maven.plugins:maven-install-plugin:3.1.1:install-file -Dfile="E:/
```
> 注:
>
> - jhinno-openapi-java-sdk-x.x.x.jar 为 SDK 的 jar 包。
> - jhinno-openapi-java-sdk-x.x.x-sources.jar 为源码包,添加可方便查看 SDK 代码的注释。