UserService · UserService_GetUser
基于协议生成的参考。授权与实例策略仍然生效。结构描述继承自 MIT 许可的应用接口定义;本站不会向真实服务执行示例。
访问权限
仅实例允许公开访问时才接受匿名调用;已认证调用仍受资源可见性和操作筛选规则限制。
用户名与响应投影
路径片段是准确的用户名。服务端按调用者身份决定返回账号字段,公开读取不等于读取私密账号数据。当前实现忽略声明的 readMask。
请求
GetUser gets a user by username. Format: users/{user} (e.g., users/steven)
GET
/api/v1/users/{user}参数
| 名称 / 位置 | 类型 / 是否必需 | 描述 |
|---|---|---|
userpath | string 必需 | The user id. |
readMaskquery | string (field-mask) OpenAPI 未标记为必需 | Optional. The fields to return in the response. If not specified, all fields are returned. |
请求体
未声明请求体。
响应
200 · OK
application/json · User
default · Default error response
application/json · Status
完整操作定义
下方保留全部已声明约束、媒体类型和响应细节。结构引用链接到完整定义。
展开 JSON 定义
{
"tags": [
"UserService"
],
"description": "GetUser gets a user by username.\n Format: users/{user} (e.g., users/steven)",
"operationId": "UserService_GetUser",
"parameters": [
{
"name": "user",
"in": "path",
"description": "The user id.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "readMask",
"in": "query",
"description": "Optional. The fields to return in the response.\n If not specified, all fields are returned.",
"schema": {
"type": "string",
"format": "field-mask"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
},
"default": {
"description": "Default error response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Status"
}
}
}
}
}
}