关键术语

  少于1分钟  

简要概述

约束生成微服务所依赖的几个公共名称

内部变量

变量名	中文名	取值范围	示例	描述
CLI_VERSION	工具版本	[0-9].\d.\d	0.3.0	生成该模版所使用的 grpc-kit-cli 版本
ORGANIZATION	组织代码	见变量组合	grpc-kit	产品所在的公司或部门
PRODUCT_CODE	产品代码	^([a-z0-9]){4,}$	opsaid	同一产品使用相同代码，使用单个词
SHORT_NAME	应用短名	^([a-z0-9]){4,}$	test1	同一产品使用不同短名，使用单个词
API_VERSION	接口版本	v[1-9]+	v1	微服务主接口版本
APPNAME	应用名称	见变量组合	opsaid-test1-v1	xx
PROTO_PACKAGE	服务包名	见变量组合	grpc_kit.api.opsaid.test1.v1	x
SERVICE_CODE	服务代码	见变量组合	test1.v1.opsaid	xx
SERVICE_TITLE	服务标题	见变量组合	OpsaidTest1	xx
SERVICE_NAME	服务全名	见变量组合	test1.v1.opsaid.api.grpc-kit.com	xx

变量组合

变量名	组合格式
APPNAME	${PRODUCT_CODE}-${SHORT_NAME}-${API_VERSION}
PROTO_PACKAGE	${ORGANIZATION}.api.${PRODUCT_CODE}.${SHORT_NAME}.${API_VERSION}
SERVICE_CODE	${SHORT_NAME}.${API_VERSION}.${PRODUCT_CODE}
SERVICE_TITLE	${PRODUCT_CODE}${SHORT_NAME}
SERVICE_NAME	${SHORT_NAME}.${API_VERSION}.${PRODUCT_CODE}.${API_GATEWAY}

注意：

1. 在 “PROTO_PACKAGE” 中，如果变量 “ORGANIZATION” 存在中化线"-"，则需转化为下划线"_"；
2. 在 “SERVICE_TITLE” 中，变量 “PRODUCT_CODE” 与 “SHORT_NAME” 首字母均大写；

---