u

code/base-project/base-go-v3/idl/auth.proto

@@ -6,50 +6,56 @@ option go_package = "auth";
 
 import "api.proto";
 
+// 登录请求
 message LoginDefaultReq {
-  string Account = 1[(api.body)="account",(api.vd)="$!=''"];
-  string Password = 2[(api.body)="password",(api.vd)="$!=''"];
+  string Account = 1 [(api.body)="account", (api.vd)="$!=''"];
+  string Password = 2 [(api.body)="password", (api.vd)="$!=''"];
 }
 
+// 登录响应
 message LoginDefaultResp {
-  string token = 1;
-  string refreshToken = 2;
-  int64 userId = 3;
-  string username = 4;
-  int32 seqNo = 5;
-  int32 gender = 6;
+  string Token = 1 [(api.body)="token"];
+  string RefreshToken = 2 [(api.body)="refreshToken"];
+  int64 UserId = 3 [(api.body)="userId"];
+  string Username = 4 [(api.body)="username"];
+  int32 SeqNo = 5 [(api.body)="seqNo"];
+  int32 Gender = 6 [(api.body)="gender"];
 }
 
+// 注册请求
 message RegisterDefaultReq {
-  string Account = 1[(api.body)="account",(api.vd)="$!=''"];
-  string Password = 2[(api.body)="password",(api.vd)="$!=''"];
+  string Account = 1 [(api.body)="account", (api.vd)="$!=''"];
+  string Password = 2 [(api.body)="password", (api.vd)="$!=''"];
 }
 
-message RegisterDefaultResp {
+// 注册响应
+message RegisterDefaultResp {}
 
-}
-
-message RefreshAccessTokenReq {
-}
+// 刷新 access token 请求
+message RefreshAccessTokenReq {}
 
+// 刷新 access token 响应
 message RefreshAccessTokenResp {
-  string accessToken = 1;
+  string AccessToken = 1 [(api.body)="accessToken"];
 }
 
+// 登录服务
 service LoginService {
   rpc LoginDefault(LoginDefaultReq) returns(LoginDefaultResp) {
     option (api.post) = "/auth/login/default";
   }
 }
 
+// 注册服务
 service RegisterService {
   rpc RegisterDefault(RegisterDefaultReq) returns(RegisterDefaultResp) {
     option (api.post) = "/auth/register/default";
   }
 }
 
+// token 服务
 service TokenService {
   rpc RefreshAccessToken(RefreshAccessTokenReq) returns(RefreshAccessTokenResp) {
-    option (api.post) = "/auth/refreshToken";
+    option (api.get) = "/auth/refresh/token";
   }
-}
+}