servicecomb-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "bismy" <bi...@qq.com>
Subject [java-chassis and other]About naming conventions for Microservice Name, Schema Id and Operation Id
Date Tue, 10 Apr 2018 09:43:05 GMT
Hi All, 


Background:
  As many features depend on these name and frequently used in yamls, environment keys, and
in program parsing, like in PR: https://github.com/apache/incubator-servicecomb-java-chassis/pull/577


  If name conventions is not defined, this will cause a lot of compatible issue. 


  e.g. when PR #577 has merged, following code will not work


1. RPC define
@RpcSchema()
class xxx


2. RPC Referent
@RpcReference(microserviceName="xx')
Service s


Suggestions:
1. require Microservice Name, Schema Id and Operation Id to follow the naming convention:
 ^[a-zA-Z]+[a-zA-Z]*
2. validate names when startup. Do not support default schemaId features, users must specify
it implicitly. 
3. Given errors and suggestions(e.g. operation id not valid, use @ApiOpertion to give explicit
id. 




Any suggestions and regards.
Mime
  • Unnamed multipart/alternative (inline, 8-Bit, 0 bytes)
View raw message