doc: add play ground demo

2026-02-04 12:52:28 +08:00 · 2023-10-08 11:19:44 +08:00
parent 56c9327a86
commit e25b53712b
11 changed files with 64 additions and 53 deletions
--- a/README.md
+++ b/README.md
@@ -453,10 +453,14 @@ import "github.com/duke-git/lancet/v2/cryptor"
    [[play](https://go.dev/play/p/uef0q1fz53I)]
 -   **<big>GenerateRsaKeyPair</big>** : creates rsa private and public key.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/cryptor.md#GenerateRsaKeyPair)]
+    [[play](https://go.dev/play/p/sSVmkfENKMz)]
 -   **<big>RsaEncryptOAEP</big>** : encrypts the given data with RSA-OAEP.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/cryptor.md#RsaEncryptOAEP)]
+    [[play](https://go.dev/play/p/sSVmkfENKMz)]
 -   **<big>RsaDecryptOAEP</big>** : decrypts the data with RSA-OAEP
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/cryptor.md#RsaDecryptOAEP)]
+    [[play](https://go.dev/play/p/sSVmkfENKMz)]
+

 <h3 id="datetime"> 7. Datetime package supports date and time format and compare. &nbsp; &nbsp; &nbsp; &nbsp;<a href="#index">index</a></h3>

@@ -1553,6 +1557,7 @@ import "github.com/duke-git/lancet/v2/strutil"
    [[play](https://go.dev/play/p/6zXRH_c0Qd3)]
 -   **<big>IsNotBlank</big>** : checks if a string is not whitespace or not empty.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/strutil.md#IsNotBlank)]
+    [[play](https://go.dev/play/p/e_oJW0RAquA)]
 -   **<big>HasPrefixAny</big>** : checks if a string starts with any of an array of specified strings.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/strutil.md#HasPrefixAny)]
    [[play](https://go.dev/play/p/8UUTl2C5slo)]
--- a/README_zh-CN.md
+++ b/README_zh-CN.md
@@ -453,10 +453,14 @@ import "github.com/duke-git/lancet/v2/cryptor"
    [[play](https://go.dev/play/p/uef0q1fz53I)]
 -   **<big>GenerateRsaKeyPair</big>** : 创建rsa公钥私钥和key。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/cryptor.md#GenerateRsaKeyPair)]
+    [[play](https://go.dev/play/p/sSVmkfENKMz)]
 -   **<big>RsaEncryptOAEP</big>** : rsa OAEP加密。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/cryptor.md#RsaEncryptOAEP)]
+    [[play](https://go.dev/play/p/sSVmkfENKMz)]
 -   **<big>RsaDecryptOAEP</big>** : rsa OAEP解密。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/cryptor.md#RsaDecryptOAEP)]
+    [[play](https://go.dev/play/p/sSVmkfENKMz)]
+

 <h3 id="datetime"> 7. datetime 日期时间处理包，格式化日期，比较日期。&nbsp; &nbsp; &nbsp; &nbsp;<a href="#index">回到目录</a></h3>

@@ -1560,6 +1564,7 @@ import "github.com/duke-git/lancet/v2/strutil"
    [[play](https://go.dev/play/p/6zXRH_c0Qd3)]
 -   **<big>IsNotBlank</big>** : 检查字符串是否不为空。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/strutil.md#IsNotBlank)]
+    [[play](https://go.dev/play/p/e_oJW0RAquA)]
 -   **<big>HasPrefixAny</big>** : 检查字符串是否以指定字符串数组中的任何一个开头。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/strutil.md#HasPrefixAny)]
    [[play](https://go.dev/play/p/8UUTl2C5slo)]
--- a/cryptor/crypto.go
+++ b/cryptor/crypto.go
@@ -508,14 +508,14 @@ func RsaDecrypt(data []byte, privateKeyFileName string) []byte {
 }

 // GenerateRsaKeyPair create rsa private and public key.
-// Play: todo
+// Play: https://go.dev/play/p/sSVmkfENKMz
 func GenerateRsaKeyPair(keySize int) (*rsa.PrivateKey, *rsa.PublicKey) {
 	privateKey, _ := rsa.GenerateKey(rand.Reader, keySize)
 	return privateKey, &privateKey.PublicKey
 }

 // RsaEncryptOAEP encrypts the given data with RSA-OAEP.
-// Play: todo
+// Play: https://go.dev/play/p/sSVmkfENKMz
 func RsaEncryptOAEP(data []byte, label []byte, key rsa.PublicKey) ([]byte, error) {
 	encryptedBytes, err := rsa.EncryptOAEP(sha256.New(), rand.Reader, &key, data, label)
 	if err != nil {
@@ -526,7 +526,7 @@ func RsaEncryptOAEP(data []byte, label []byte, key rsa.PublicKey) ([]byte, error
 }

 // RsaDecryptOAEP decrypts the data with RSA-OAEP.
-// Play: todo
+// Play: https://go.dev/play/p/sSVmkfENKMz
 func RsaDecryptOAEP(ciphertext []byte, label []byte, key rsa.PrivateKey) ([]byte, error) {
 	decryptedBytes, err := rsa.DecryptOAEP(sha256.New(), rand.Reader, &key, ciphertext, label)
 	if err != nil {
--- a/docs/api/packages/cryptor.md
+++ b/docs/api/packages/cryptor.md
@@ -1437,7 +1437,7 @@ func main() {
 func GenerateRsaKeyPair(keySize int) (*rsa.PrivateKey, *rsa.PublicKey)
 ```

-<b>示例:></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/sSVmkfENKMz)</span></b>

 ```go
 package main
@@ -1462,7 +1462,7 @@ func main() {
 func RsaEncryptOAEP(data []byte, label []byte, key rsa.PublicKey) ([]byte, error)
 ```

-<b>示例:></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/sSVmkfENKMz)</span></b>

 ```go
 package main
@@ -1505,7 +1505,7 @@ func main() {
 func RsaDecryptOAEP(ciphertext []byte, label []byte, key rsa.PrivateKey) ([]byte, error)
 ```

-<b>示例:></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/sSVmkfENKMz)</span></b>

 ```go
 package main
--- a/docs/api/packages/fileutil.md
+++ b/docs/api/packages/fileutil.md
@@ -843,7 +843,7 @@ func main() {

 ### <span id="ReadFile">ReadFile</span>

-<p>读取文件或者URL</p>
+<p>读取文件或者URL。</p>

 <b>函数签名:</b>

@@ -851,7 +851,7 @@ func main() {
 func ReadFile(path string) (reader io.ReadCloser, closeFn func(), err error) 
 ```

-<b>示例:<span style="float:right;display:inline-block;"></span></b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/uNep3Tr8fqF)</span></b>

 ```go
 package main
@@ -862,19 +862,19 @@ import (
 )

 func main() {
-   reader, fn, err := ReadFile("https://httpbin.org/robots.txt")
-	if err != nil {
-		return
-	}
-	defer fn()
+    reader, fn, err := fileutil.ReadFile("https://httpbin.org/robots.txt")
+    if err != nil {
+        return
+    }
+    defer fn()

-	dat, err := io.ReadAll(reader)
-	if err != nil {
-		return
-	}
-	fmt.Println(string(dat))
-	// Output:
-	// User-agent: *
-	// Disallow: /deny
+    dat, err := io.ReadAll(reader)
+    if err != nil {
+        return
+    }
+    fmt.Println(string(dat))
+    // Output:
+    // User-agent: *
+    // Disallow: /deny
 }
 ```
--- a/docs/api/packages/strutil.md
+++ b/docs/api/packages/strutil.md
@@ -1080,13 +1080,13 @@ func main() {

 <p>Checks if a string is not whitespace or not empty.</p>

-<b>Signature:</b>
+<b>函数签名:</b>

 ```go
 func IsNotBlank(str string) bool
 ```

-<b>Example:</b>
+<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/e_oJW0RAquA)</span></b>

 ```go
 import (
@@ -1095,11 +1095,11 @@ import (
 )

 func main() {
-    result1 := IsNotBlank("")
-    result2 := IsNotBlank("	")
-    result3 := IsNotBlank("\t\v\f\n")
-    result4 := IsNotBlank(" 中文")
-    result5 := IsNotBlank(" 	world	")
+    result1 := strutil.IsNotBlank("")
+    result2 := strutil.IsNotBlank("	")
+    result3 := strutil.IsNotBlank("\t\v\f\n")
+    result4 := strutil.IsNotBlank(" 中文")
+    result5 := strutil.IsNotBlank(" 	world	")
    
    fmt.Println(result1)
    fmt.Println(result2)
--- a/docs/en/api/packages/cryptor.md
+++ b/docs/en/api/packages/cryptor.md
@@ -1437,7 +1437,7 @@ func main() {
 func GenerateRsaKeyPair(keySize int) (*rsa.PrivateKey, *rsa.PublicKey)
 ```

-<b>Example:></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/sSVmkfENKMz)</span></b>

 ```go
 package main
@@ -1462,7 +1462,7 @@ func main() {
 func RsaEncryptOAEP(data []byte, label []byte, key rsa.PublicKey) ([]byte, error)
 ```

-<b>Example:></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/sSVmkfENKMz)</span></b>

 ```go
 package main
@@ -1505,7 +1505,7 @@ func main() {
 func RsaDecryptOAEP(ciphertext []byte, label []byte, key rsa.PrivateKey) ([]byte, error)
 ```

-<b>Example:></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/sSVmkfENKMz)</span></b>

 ```go
 package main
--- a/docs/en/api/packages/fileutil.md
+++ b/docs/en/api/packages/fileutil.md
@@ -843,7 +843,7 @@ func main() {

 ### <span id="ReadFile">ReadFile</span>

-<p>Read File/URL</p>
+<p>Read File or URL.</p>

 <b>Signature:</b>

@@ -851,7 +851,7 @@ func main() {
 func ReadFile(path string) (reader io.ReadCloser, closeFn func(), err error) 
 ```

-<b>Example:<span style="float:right;display:inline-block;"> </span></b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/uNep3Tr8fqF)</span></b>

 ```go
 package main
@@ -862,19 +862,19 @@ import (
 )

 func main() {
-   reader, fn, err := ReadFile("https://httpbin.org/robots.txt")
-	if err != nil {
-		return
-	}
-	defer fn()
+    reader, fn, err := fileutil.ReadFile("https://httpbin.org/robots.txt")
+    if err != nil {
+        return
+    }
+    defer fn()

-	dat, err := io.ReadAll(reader)
-	if err != nil {
-		return
-	}
-	fmt.Println(string(dat))
-	// Output:
-	// User-agent: *
-	// Disallow: /deny
+    dat, err := io.ReadAll(reader)
+    if err != nil {
+        return
+    }
+    fmt.Println(string(dat))
+    // Output:
+    // User-agent: *
+    // Disallow: /deny
 }
 ```
--- a/docs/en/api/packages/strutil.md
+++ b/docs/en/api/packages/strutil.md
@@ -1087,7 +1087,7 @@ func main() {
 func IsNotBlank(str string) bool
 ```

-<b>Example:</b>
+<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/e_oJW0RAquA)</span></b>

 ```go
 import (
@@ -1096,11 +1096,11 @@ import (
 )

 func main() {
-    result1 := IsNotBlank("")
-    result2 := IsNotBlank("	")
-    result3 := IsNotBlank("\t\v\f\n")
-    result4 := IsNotBlank(" 中文")
-    result5 := IsNotBlank(" 	world	")
+    result1 := strutil.IsNotBlank("")
+    result2 := strutil.IsNotBlank("	")
+    result3 := strutil.IsNotBlank("\t\v\f\n")
+    result4 := strutil.IsNotBlank(" 中文")
+    result5 := strutil.IsNotBlank(" 	world	")
    
    fmt.Println(result1)
    fmt.Println(result2)
--- a/fileutil/file.go
+++ b/fileutil/file.go
@@ -627,7 +627,7 @@ func WriteBytesToFile(filepath string, content []byte) error {
 }

 // ReadFile get file reader by a url or a local file
-// Play: todo
+// Play: https://go.dev/play/p/uNep3Tr8fqF
 func ReadFile(path string) (reader io.ReadCloser, closeFn func(), err error) {
 	switch {
 	case validator.IsUrl(path):
--- a/strutil/string.go
+++ b/strutil/string.go
@@ -409,6 +409,7 @@ func IsBlank(str string) bool {
 }

 // IsNotBlank checks if a string is not whitespace, not empty.
+// Play: https://go.dev/play/p/e_oJW0RAquA
 func IsNotBlank(str string) bool {
 	return !IsBlank(str)
 }