update docs

Author: zhufuyi

.github/RELEASE.md

@@ -1,7 +1,6 @@
 ## New
 
-- Add generate cache code command and UI interface.
-- Convert swagger.json 64-bit fields type string to integer.
-- Uniform json name style for camel case.
-- Convert rpc code to http code.
-- Update documentation.
+- Passing metadata from the web service to the RPC service.
+- Delete json tag omitempty.
+- Add a project example.
+- Add a microservice cluster project example.

README.md

@@ -81,13 +81,20 @@ Visit `http://localhost:24631` in your browser, generate code by manipulating it
 
 ### Examples of use
 
+#### Basic Services example
+
 - [1_web-gin-CRUD](https://github.com/zhufuyi/sponge_examples/tree/main/1_web-gin-CRUD)
 - [2_web-gin-protobuf](https://github.com/zhufuyi/sponge_examples/tree/main/2_web-gin-protobuf)
 - [3_micro-grpc-CRUD](https://github.com/zhufuyi/sponge_examples/tree/main/3_micro-grpc-CRUD)
 - [4_micro-grpc-protobuf](https://github.com/zhufuyi/sponge_examples/tree/main/4_micro-grpc-protobuf)
 - [5_micro-gin-rpc-gateway](https://github.com/zhufuyi/sponge_examples/tree/main/5_micro-gin-rpc-gateway)
 - [6_micro-cluster](https://github.com/zhufuyi/sponge_examples/tree/main/6_micro-cluster)
 
+#### Full project example
+
+- [7_community-single](https://github.com/zhufuyi/sponge_examples/tree/main/7_community-single)
+- [8_community-cluster](https://github.com/zhufuyi/sponge_examples/tree/main/8_community-cluster)
+
 <br>
 
 ### Documentation

assets/readme-cn.md

@@ -63,12 +63,19 @@ sponge run
 
 ### 使用示例
 
-- [1_web-gin-CRUD](https://www.bilibili.com/read/cv23018269)
-- [2_web-gin-protobuf](https://www.bilibili.com/read/cv23040234)
-- [3_micro-grpc-CRUD](https://www.bilibili.com/read/cv23064432)
-- [4_micro-grpc-protobuf](https://www.bilibili.com/read/cv23099236)
-- [5_micro-gin-rpc-gateway](https://www.bilibili.com/read/cv23189890)
-- [6_micro-cluster](https://www.bilibili.com/read/cv23255594)
+#### 基础服务示例
+
+- [1_web-gin-CRUD](https://github.com/zhufuyi/sponge_examples/tree/main/1_web-gin-CRUD)
+- [2_web-gin-protobuf](https://github.com/zhufuyi/sponge_examples/tree/main/2_web-gin-protobuf)
+- [3_micro-grpc-CRUD](https://github.com/zhufuyi/sponge_examples/tree/main/3_micro-grpc-CRUD)
+- [4_micro-grpc-protobuf](https://github.com/zhufuyi/sponge_examples/tree/main/4_micro-grpc-protobuf)
+- [5_micro-gin-rpc-gateway](https://github.com/zhufuyi/sponge_examples/tree/main/5_micro-gin-rpc-gateway)
+- [6_micro-cluster](https://github.com/zhufuyi/sponge_examples/tree/main/6_micro-cluster)
+
+#### 完整项目示例
+
+- [7_community-single](https://github.com/zhufuyi/sponge_examples/tree/main/7_community-single)
+- [8_community-cluster](https://github.com/zhufuyi/sponge_examples/tree/main/8_community-cluster)
 
 <br>
 

pkg/errcode/http_error.go

@@ -94,7 +94,7 @@ func ParseError(err error) *Error {
 return Success
 }
 
-unknownError := &Error{
+outError := &Error{
 code: -1,
 msg: "unknown error",
 }
@@ -103,12 +103,17 @@ func ParseError(err error) *Error {
 codeStr := strings.ReplaceAll(splits[0], "code = ", "")
 code, er := strconv.Atoi(codeStr)
 if er != nil {
-return unknownError
+return outError
 }
 
 if e, ok := errCodes[code]; ok {
+if len(splits) > 1 {
+outError.code = code
+outError.msg = splits[1]
+return outError
+}
 return e
 }
 
-return unknownError
+return outError
 }

pkg/errcode/http_error_test.go

@@ -43,7 +43,7 @@ func TestNewError(t *testing.T) {
 Aborted,
 OutOfRange,
 Unimplemented,
-DataLoss,
+DataLoss.WithDetails("foo", "bar"),
 NewError(1010, "unknown"),
 }
 

pkg/jwt/option.go

@@ -28,7 +28,7 @@ func Init(opts ...Option) {
 var (
 defaultSigningKey = []byte("zaq12wsxmko0") // default key
 defaultSigningMethod = SigningMethodHS256 // default HS256
-defaultExpire = 2 * time.Hour  // default expiration
+defaultExpire = 24 * time.Hour // default expiration
 defaultIssuer = ""
 )
 

scripts/protoc.sh

@@ -109,7 +109,8 @@ function generateBySpecifiedProto(){
 
  checkResult $?
 
- sponge web swagger --file=docs/apis.swagger.json
+ # convert 64-bit fields type string to integer
+ sponge web swagger --file=docs/apis.swagger.json > /dev/null
  checkResult $?
 
  echo ""
@@ -138,6 +139,10 @@ generateBySpecifiedProto
 # delete unused packages in pb.go
 handlePbGoFiles $protoBasePath
 
+# delete json tag omitempty
+sponge del-omitempty --dir=$protoBasePath --suffix-name=pb.go > /dev/null
+checkResult $?
+
 go mod tidy
 checkResult $?