Skip to content

Commit

Permalink
* update document
Browse files Browse the repository at this point in the history
  • Loading branch information
@junqizhang-dev
junqizhang-dev committed Aug 8, 2020
1 parent c27eb3e commit f9ac5ec
Show file tree
Hide file tree
Showing 5 changed files with 109 additions and 109 deletions.
28 changes: 14 additions & 14 deletions readthedocs/zh_CN/docs/one-stop-experience.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,46 +23,46 @@ WeIdentity 入门


第1步：安装 WeIdentity 部署工具
------------------------------
------------------------------------------

您可以参照\ `“安装 WeIdentity 部署工具” <./weidentity-installation-by-web.html>`_\，安装 WeIdentity 部署工具。
您可以参照\ `“安装 WeIdentity 部署工具” <./weidentity-installation-by-web.html>`_\，安装 WeIdentity 部署工具，这是一个网页工具，可以通过工具可以完成WeIdentity的部署，同时也提供了一些其他功能。

第2步：使用 WeIdentity 部署工具完成部署
---------------------------------------
---------------------------------------------------

参照\ `配置教程 <./deploy-via-web.html>`_\，完成配置和部署。
参照\ `“配置教程” <./deploy-via-web.html>`_\，完成配置和部署。


第3步：运行 Sample 代码，体验接口（可选）
-------------------------------------------------
-------------------------------------------------------------

.. note::
如果不想体验 Sample，可以直接跳过这一步


您可以参考\ `开发样例使用 <./weidentity-sample-tryit.html>`_\，体验 WeIdentity 的各种接口。
您可以参考\ `“开发样例使用” <./weidentity-sample-tryit.html>`_\，体验 WeIdentity 的各种接口。


第4步：在自己的 Java Service 中集成 WeIdentity Java SDK
-----------------------------------------------------
-----------------------------------------------------------------

参考：\ `集成 WeIdentity Java SDK <sdk-integration.html>`_\
参考：\ `“集成 WeIdentity Java SDK” <sdk-integration.html>`_\

.. note::
如果您是要的是其他语言而非 Java，可以参照\ `RestService文档 <./weidentity-rest.html>`_\，通过 WeIdentity Rest Service 来调用相关的接口。


其他：WeIdentity Java SDK 接口文档
------------------------------------
------------------------------------------------

参考\ `Java SDK文档 <https://weidentity.readthedocs.io/projects/javasdk/zh_CN/latest/>`_\，深入了解 WeIdentity 的接口调用。
参考\ `“Java SDK文档” <https://weidentity.readthedocs.io/projects/javasdk/zh_CN/latest/>`_\，深入了解 WeIdentity 的接口调用。

其他： WeIdentity 部署工具其他功能介绍
-----------------------------------------
-----------------------------------------------------

参考\ `WeIdentity 部署工具使用简介 <./weidentity-quick-tools-web.html>`_\。
参考\ `“WeIdentity 部署工具使用简介” <./weidentity-quick-tools-web.html>`_\。

其他： WeIdentity 命令行工具使用
-----------------------------------------
-----------------------------------------------------

我们提供了一些快捷工具，可以帮您快速体验 weid-java-sdk，请参考\ `WeIdentity JAVA SDK 便捷工具使用 <./weidentity-quick-tools.html>`__\。
我们提供了一些快捷工具，可以帮您快速体验 weid-java-sdk，请参考\ `“WeIdentity JAVA SDK 便捷工具使用” <./weidentity-quick-tools.html>`__\。
1 change: 1 addition & 0 deletions readthedocs/zh_CN/docs/weidentity-installation-by-web.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ WeIdentity 安装部署工具使用文档（可视化安装部署方式）
.. note::
- 默认会下载最新版本的可视化安装工具，如果想指定安装版本，可以通过 :code:`-v` 指定”WeIdentity 安装部署工具“的版本号（注意，不是 WeIdentity Java SDK 的版本号），例如执行： :code:`./weid-install.sh -v 1.0.12`。
- 查看\ `“WeIdentity 部署工具”历史版本 <https://search.maven.org/artifact/com.webank/weid-build-tools>`_\

3.启动Web服务
""""""""""""""
Expand Down
10 changes: 4 additions & 6 deletions readthedocs/zh_CN/docs/weidentity-sample-deploy.rst
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
部署 weid-java-sdk 与配置基本信息
---------------
-------------------------------------------

配置 Committee Member 私钥
~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. note::
此项配置并非必要。由于注册 Authority Issuer 需要委员会机构成员（ Committee Member ）权限，若您不是发布智能合约的机构，您无需关注此配置项。
Expand All @@ -14,7 +14,7 @@


配置weidentity.properties
~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: shell
Expand All @@ -34,11 +34,9 @@
nodes=10.10.10.10:20200
配置节点证书和密钥文件
~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~
::

cd resources/

FISCO BCOS 2.0请参考\ `2.0 web3sdk客户端配置 <https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/sdk/java_sdk.html#sdk>`__\，将证书文件 ``ca.crt``， ``node.crt`` 和 ``node.key`` 复制出来，拷贝至当前目录下。


173 changes: 87 additions & 86 deletions readthedocs/zh_CN/docs/weidentity-sample-tryit.rst
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
体验使用WeIdentity Sample
---------------
------------------------------

前提条件
~~~~~~~~
Expand Down Expand Up @@ -38,12 +38,89 @@ weid-sample 的配置。

.. code:: shell
chmod +x build.sh
./build.sh
chmod +x build.sh
./build.sh

2. Swagger服务方式体验接口
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

2. 命令行方式使用
~~~~~~~~
使用 spring-boot 方式，weid-sample 程序将作为一个后台进程运行，您可以使用swagger可视化地体验交互流程。

2.1 启用服务
''''''''''''''''''''''''

.. code:: shell
chmod +x build.sh start.sh stop.sh
./start.sh
若启动成功，则会打印以下信息：

::

[main] INFO AnnotationMBeanExporter() - Registering beans for JMX exposure on startup
[main] INFO Http11NioProtocol() - Initializing ProtocolHandler ["https-jsse-nio-6101"]
[main] INFO Http11NioProtocol() - Starting ProtocolHandler ["https-jsse-nio-6100"]
[main] INFO NioSelectorPool() - Using a shared selector for servlet write/read
[main] INFO Http11NioProtocol() - Initializing ProtocolHandler ["http-nio-6101"]
[main] INFO NioSelectorPool() - Using a shared selector for servlet write/read
[main] INFO Http11NioProtocol() - Starting ProtocolHandler ["http-nio-6101"]
[main] INFO TomcatEmbeddedServletContainer() - Tomcat started on port(s): 6100 (https) 6101 (http)
[main] INFO SampleApp() - Started SampleApp in 3.588 seconds (JVM running for 4.294)

2.2 流程演示
''''''''''''''''''''''''

以下将为您演示
假设您的服务部署在本地，地址是 ``127.0.0.1``，服务端口是 ``6101``。您可以在 ``resources/`` 里修改端口信息。
您可以使用浏览器打开http://127.0.0.1:6101/swagger-ui.html，通过可视化的方式体验WeIdentity的核心功能。

- 创建 WeID

单击``/step1/issuer/createWeId``，创建WeID，并返回结果。

若调用成功，则会显示以下信息：

.. image:: images/weid-sample-springboot-1.png

表明创建的 WeID 是 did:weid:1:0xbb96163789a4e16790f3d213319bd4cf2b517582。

- 注册 Cpt

单击``/step2/registCpt``，参数里的 publisher 传入step1刚刚注册的WeID

运行成功，则会打印以下信息：

.. image:: images/weid-sample-springboot-2.png

表明注册 CPT 成功，CPT ID 为 2000000。

- 创建 Credential

单击``/step3/createCredential``，修改参数``claimData``为具体值，参数issuer为step1的WeID，参数cptId为step2返回的Cpt ID


运行成功，则会打印以下信息：

.. image:: images/weid-sample-springboot-3.png

表明创建 Credential 成功，Credential 的具体信息为图中的 credential 字段对应的内容。

- 验证 Credential

单击``/step1/verifyCredential``，修改参数为上步所得到的``credential``。

若运行成功，则会打印以下信息：

.. image:: images/weid-sample-springboot-4.png

表明 Credential 验证成功。

至此，您已经体验了 weid-sample 实现的各个角色的运行流程，实现的入口类在weid-sample工程的 ``com.webank.weid.demo.server.SampleApp``，您可以参考进行您的 Java 应用开发。


3. 命令行方式使用
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

命令行方式比较完整的模拟了各个 \ `WeIdentity 角色 <./weidentity-spec.html#id9>`__\ 的工作流程，可以帮您快速体验 WeIdentity 也业务流程和运行机制。
各个角色的基本流程如下：
Expand All @@ -67,7 +144,7 @@ weid-sample 的配置。
| 验证 Presentation

2.1 基本流程的演示
3.1 基本流程的演示
''''''''''''''''''''''''


Expand All @@ -83,7 +160,7 @@ weid-sample 的配置。
以下为截取的部分流程日志：
::


--------- start issuer ----------
issuer() init...

Expand Down Expand Up @@ -125,11 +202,11 @@ weid-sample 的配置。
./command.sh user_agent
运行成功，则会打印包括创建 WeID、创建 Presentation 以及打包 Presentation 成 QRcode 或者 Json 串的流程。
以下为截取的部分日志：
以下为截取的部分日志：

::


--------- start User Agent ----------
userAgent() init...

Expand Down Expand Up @@ -194,86 +271,10 @@ weid-sample 的配置。
至此，您已经体验了 WeIdentity-Sample 实现的各个角色的运行流程，实现的入口类在 WeIdentity-Sample 工程的 ``com.webank.weid.demo.command.DemoCommand``，您可以参考进行您的 Java 应用开发。


3. Spring-boot服务方式使用
~~~~~~~~

使用 spring-boot 方式，weid-sample 程序将作为一个后台进程运行，您可以使用swagger可视化地体验交互流程。

3.1 启用服务
''''''''''''''''''''''''

.. code:: shell
chmod +x build.sh start.sh stop.sh
./start.sh
若启动成功，则会打印以下信息：

::

[main] INFO AnnotationMBeanExporter() - Registering beans for JMX exposure on startup
[main] INFO Http11NioProtocol() - Initializing ProtocolHandler ["https-jsse-nio-6101"]
[main] INFO Http11NioProtocol() - Starting ProtocolHandler ["https-jsse-nio-6100"]
[main] INFO NioSelectorPool() - Using a shared selector for servlet write/read
[main] INFO Http11NioProtocol() - Initializing ProtocolHandler ["http-nio-6101"]
[main] INFO NioSelectorPool() - Using a shared selector for servlet write/read
[main] INFO Http11NioProtocol() - Starting ProtocolHandler ["http-nio-6101"]
[main] INFO TomcatEmbeddedServletContainer() - Tomcat started on port(s): 6100 (https) 6101 (http)
[main] INFO SampleApp() - Started SampleApp in 3.588 seconds (JVM running for 4.294)

3.2 流程演示
''''''''''''''''''''''''

以下将为您演示
假设您的服务部署在本地，地址是 ``127.0.0.1``，服务端口是 ``6101``。您可以在 ``resources/`` 里修改端口信息。
您可以使用浏览器打开http://127.0.0.1:6101/swagger-ui.html，通过可视化的方式体验WeIdentity的核心功能。

- 创建 WeID

单击``/step1/issuer/createWeId``，创建WeID，并返回结果。

若调用成功，则会显示以下信息：

.. image:: images/weid-sample-springboot-1.png

表明创建的 WeID 是 did:weid:1:0xbb96163789a4e16790f3d213319bd4cf2b517582。

- 注册 Cpt

单击``/step2/registCpt``，参数里的 publisher 传入step1刚刚注册的WeID

运行成功，则会打印以下信息：

.. image:: images/weid-sample-springboot-2.png

表明注册 CPT 成功，CPT ID 为 2000000。

- 创建 Credential

单击``/step3/createCredential``，修改参数``claimData``为具体值，参数issuer为step1的WeID，参数cptId为step2返回的Cpt ID


运行成功，则会打印以下信息：

.. image:: images/weid-sample-springboot-3.png

表明创建 Credential 成功，Credential 的具体信息为图中的 credential 字段对应的内容。

- 验证 Credential

单击``/step1/verifyCredential``，修改参数为上步所得到的``credential``。

若运行成功，则会打印以下信息：

.. image:: images/weid-sample-springboot-4.png

表明 Credential 验证成功。

至此，您已经体验了 weid-sample 实现的各个角色的运行流程，实现的入口类在weid-sample工程的 ``com.webank.weid.demo.server.SampleApp``，您可以参考进行您的 Java 应用开发。


.. toctree::
:hidden:
:maxdepth: 1

weidentity-sample-deploy.rst
weidentity-sample-deploy.rst
6 changes: 3 additions & 3 deletions readthedocs/zh_CN/docs/weidentity-sample.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ WeIdentity Sample 开发样例
环境准备
^^^^^^^^^^^^^^^^^^^^^^^^^^

您可以参考 WeIdentity JAVA SDK 安装部署文档中的\ `准备工作 <./weidentity-installation.html#id2>`__\ 章节进行准备。
您可以参考 WeIdentity 安装部署文档\ `准备工作 <./one-stop-experience.rst>`__\ 进行准备。

快速体验
^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -22,5 +22,5 @@ WeIdentity Sample 开发样例
.. toctree::
:hidden:
:maxdepth: 1
weidentity-sample-tryit.rst

weidentity-sample-tryit.rst

0 comments on commit f9ac5ec

Please sign in to comment.