mirror of
https://github.com/zhufuyi/sponge.git
synced 2025-10-06 09:17:19 +08:00
match name xxxID in proto file
This commit is contained in:
@@ -1046,7 +1046,7 @@ func goTypeToProto(fields []tmplField) []tmplField {
|
||||
field.GoType = "uint64"
|
||||
}
|
||||
}
|
||||
|
||||
field.JSONName = customToCamel(field.ColName)
|
||||
newFields = append(newFields, field)
|
||||
}
|
||||
return newFields
|
||||
@@ -1080,9 +1080,8 @@ func getDefaultValue(expr ast.ExprNode) (value string) {
|
||||
}
|
||||
|
||||
var acronym = map[string]struct{}{
|
||||
"ID": {},
|
||||
"IP": {},
|
||||
"RPC": {},
|
||||
"ID": {},
|
||||
"IP": {},
|
||||
}
|
||||
|
||||
func toCamel(s string) string {
|
||||
@@ -1139,3 +1138,10 @@ func firstLetterToLow(str string) string {
|
||||
|
||||
return str
|
||||
}
|
||||
|
||||
func customToCamel(str string) string {
|
||||
if strings.ToLower(str) == "id" {
|
||||
return str
|
||||
}
|
||||
return firstLetterToLow(toCamel(str))
|
||||
}
|
||||
|
@@ -116,8 +116,15 @@ func TestParseSQLs(t *testing.T) {
|
||||
}
|
||||
|
||||
func Test_toCamel(t *testing.T) {
|
||||
str := "user_example"
|
||||
t.Log(toCamel(str))
|
||||
names := []string{"id", "user_id", "productId", "orderId", "user_name", "host_ip", "teacherId"}
|
||||
var convertNames []string
|
||||
var convertNames2 []string
|
||||
for _, name := range names {
|
||||
convertNames = append(convertNames, toCamel(name))
|
||||
convertNames2 = append(convertNames2, customToCamel(name))
|
||||
}
|
||||
t.Log(convertNames)
|
||||
t.Log(convertNames2)
|
||||
}
|
||||
|
||||
func Test_parseOption(t *testing.T) {
|
||||
|
@@ -161,7 +161,7 @@ message List{{.TableName}}Request {
|
||||
}
|
||||
|
||||
message List{{.TableName}}Reply {
|
||||
int64 total =1;
|
||||
int64 total = 1;
|
||||
repeated {{.TableName}} {{.TName}}s = 2;
|
||||
}
|
||||
|
||||
@@ -265,7 +265,7 @@ message List{{.TableName}}Request {
|
||||
}
|
||||
|
||||
message List{{.TableName}}Reply {
|
||||
int64 total =1;
|
||||
int64 total = 1;
|
||||
repeated {{.TableName}} {{.TName}}s = 2;
|
||||
}
|
||||
`
|
||||
@@ -320,6 +320,12 @@ service {{.TName}} {
|
||||
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
||||
summary: "create {{.TName}}",
|
||||
description: "submit information to create {{.TName}}",
|
||||
//security: {
|
||||
// security_requirement: {
|
||||
// key: "BearerAuth";
|
||||
// value: {}
|
||||
// }
|
||||
//}
|
||||
};
|
||||
}
|
||||
|
||||
@@ -465,17 +471,20 @@ service {{.TName}} {
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// Some notes on defining fields under message:
|
||||
// (1) Fill in the validate rules https://github.com/envoyproxy/protoc-gen-validate#constraint-rules
|
||||
// (2) When using the protoc-gen-openapiv2 plugin, if the defined fields are snake case,
|
||||
// you must add annotations for snake case names, such as string foo_bar = 1 [json_name = "foo_bar"],
|
||||
// (2) Suggest using camel hump naming for message field names, and for names ending in 'id',
|
||||
// use xxxID naming format, such as userID, orderID, etc.
|
||||
// (3) When using the protoc-gen-openapiv2 plugin, if the defined fields are snake case,
|
||||
// you must add annotations for snake case names, such as string fieldName = 1 [json_name = "field_name"],
|
||||
// to ensure that the front end and back end JSON naming is consistent.
|
||||
// (3) If the route contains the path parameter, such as /api/v1/userExample/{id}, the defined
|
||||
// (4) If the route contains the path parameter, such as /api/v1/userExample/{id}, the defined
|
||||
// message must contain the name of the path parameter and the name should be
|
||||
// added with a new tag, such as int64 id = 1 [(tagger.tags) = "uri:\"id\""];
|
||||
// (4) If the request url is followed by a query parameter, such as /api/v1/getUserExample?name=Tom,
|
||||
// (5) If the request url is followed by a query parameter, such as /api/v1/getUserExample?name=Tom,
|
||||
// a form tag must be added when defining the query parameter in the message,
|
||||
// such as string name = 1 [(tagger.tags) = "form:\"name\""];
|
||||
// such as string name = 1 [(tagger.tags) = "form:\"name\""].
|
||||
|
||||
|
||||
// protoMessageCreateCode
|
||||
@@ -513,7 +522,7 @@ message List{{.TableName}}Request {
|
||||
}
|
||||
|
||||
message List{{.TableName}}Reply {
|
||||
int64 total =1;
|
||||
int64 total = 1;
|
||||
repeated {{.TableName}} {{.TName}}s = 2;
|
||||
}
|
||||
|
||||
@@ -602,6 +611,12 @@ service {{.TName}} {
|
||||
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
||||
summary: "create {{.TName}}",
|
||||
description: "submit information to create {{.TName}}",
|
||||
//security: {
|
||||
// security_requirement: {
|
||||
// key: "BearerAuth";
|
||||
// value: {}
|
||||
// }
|
||||
//}
|
||||
};
|
||||
}
|
||||
|
||||
@@ -676,17 +691,20 @@ service {{.TName}} {
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// Some notes on defining fields under message:
|
||||
// (1) Fill in the validate rules https://github.com/envoyproxy/protoc-gen-validate#constraint-rules
|
||||
// (2) When using the protoc-gen-openapiv2 plugin, if the defined fields are snake case,
|
||||
// you must add annotations for snake case names, such as string foo_bar = 1 [json_name = "foo_bar"],
|
||||
// (2) Suggest using camel hump naming for message field names, and for names ending in 'id',
|
||||
// use xxxID naming format, such as userID, orderID, etc.
|
||||
// (3) When using the protoc-gen-openapiv2 plugin, if the defined fields are snake case,
|
||||
// you must add annotations for snake case names, such as string fieldName = 1 [json_name = "field_name"],
|
||||
// to ensure that the front end and back end JSON naming is consistent.
|
||||
// (3) If the route contains the path parameter, such as /api/v1/userExample/{id}, the defined
|
||||
// (4) If the route contains the path parameter, such as /api/v1/userExample/{id}, the defined
|
||||
// message must contain the name of the path parameter and the name should be
|
||||
// added with a new tag, such as int64 id = 1 [(tagger.tags) = "uri:\"id\""];
|
||||
// (4) If the request url is followed by a query parameter, such as /api/v1/getUserExample?name=Tom,
|
||||
// (5) If the request url is followed by a query parameter, such as /api/v1/getUserExample?name=Tom,
|
||||
// a form tag must be added when defining the query parameter in the message,
|
||||
// such as string name = 1 [(tagger.tags) = "form:\"name\""];
|
||||
// such as string name = 1 [(tagger.tags) = "form:\"name\""].
|
||||
|
||||
|
||||
// protoMessageCreateCode
|
||||
@@ -724,7 +742,7 @@ message List{{.TableName}}Request {
|
||||
}
|
||||
|
||||
message List{{.TableName}}Reply {
|
||||
int64 total =1;
|
||||
int64 total = 1;
|
||||
repeated {{.TableName}} {{.TName}}s = 2;
|
||||
}
|
||||
`
|
||||
|
Reference in New Issue
Block a user