[GitHub] [apisix] membphis commented on a change in pull request #2599: Plugins(Doc): Optimize the document for hmac-auth

[GitBox <gi...@apache.org>]

membphis commented on a change in pull request #2599:
URL: https://github.com/apache/apisix/pull/2599#discussion_r516468684



##########
File path: doc/examples/plugins-hmac-auth-generate-signature.md
##########
@@ -0,0 +1,203 @@
+

Review comment:
       remove this useless line

##########
File path: doc/zh-cn/plugins/hmac-auth.md
##########
@@ -206,3 +209,21 @@ $ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f
     }
 }'
 ```
+
+## 签名生成示例
+
+以 HMAC SHA256 为例，介绍一下各种语言的签名生成示例。
+
+示例入参说明:
+Variable | Value
+---|---
+secret | this is secret key
+message | this is signature string
+
+示例出参说明：
+Type | Hash

Review comment:
       ditto

##########
File path: doc/zh-cn/plugins/hmac-auth.md
##########
@@ -206,3 +209,21 @@ $ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f
     }
 }'
 ```
+
+## 签名生成示例
+
+以 HMAC SHA256 为例，介绍一下各种语言的签名生成示例。
+
+示例入参说明:
+Variable | Value

Review comment:
       add a blank line before the table




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org