14个发布版本
| 0.1.6 | 2021年8月29日 |
|---|---|
| 0.1.5 | 2021年8月28日 |
| 0.0.9 | 2021年8月11日 |
| 0.0.3 | 2021年7月14日 |
#31 in #api-server
每月51次下载
175KB
3K SLoC
Rust的hvcg_iam_openapi_identity API
这是一个身份API。
概述
此客户端/服务器由[openapi-generator]（https://openapi-generator.tech）项目生成。通过使用来自远程服务器的OpenAPI-Spec，您可以轻松生成服务器存根。
要了解如何将其用于自己的项目，请参阅此处
- API版本：0.1.6
- 构建日期：2021-08-29T04:13:56.401156901Z[Etc/UTC]
此自动生成的项目定义了一个名为hvcg_iam_openapi_identity的API包，其中包含
- 一个定义Rust中API的
Api特质。 - 表示底层数据模型的数据类型。
- 一个实现
Api并针对每个操作发出HTTP请求的Client类型。 - 一个路由器，它接受HTTP请求并针对每个操作调用适当的
Api方法。
它还包括一个示例服务器和客户端，它们使用hvcg_iam_openapi_identity。
- 示例服务器使用
hvcg_iam_openapi_identity路由器启动一个Web服务器，并提供了对每个操作返回失败的简单实现。 - 示例客户端提供了一个CLI，允许您通过在命令行中传递适当的参数来调用
hvcg_iam_openapi_identity客户端上的任何单个操作。
您可以使用示例服务器和客户端作为自己代码的基础。有关实现服务器的更多详细信息，请参阅下面的说明。
示例
使用以下命令运行示例
cargo run --example <example-name>
要将参数传递给示例，请将其放在--之后，例如
cargo run --example client -- --help
运行示例服务器
要运行服务器，请按照以下简单步骤操作
cargo run --example server
运行示例客户端
要运行客户端，请按照以下简单步骤之一操作
cargo run --example client QueryUserById
cargo run --example client QueryUsers
cargo run --example client DeleteUser
HTTPS
可以通过传递标志--https在HTTPS模式下运行示例，例如
cargo run --example server -- --https
这将在示例目录中使用密钥/证书。请注意，服务器链由CN=localhost签名。
使用生成的库
生成的库有几个可选功能可以通过Cargo激活。
服务器- 默认启用，并基于hyper创建服务器实现的基本框架。
- 要创建服务器栈，您需要提供一个实现API特质的实现来提供服务器功能。
客户端- 默认启用，并基于hyper创建客户端实现的基本框架。
- 构建的客户端通过远程API调用实现API特质。
转换- 默认禁用，并为模型创建额外的派生以允许结构类似类型的对象之间的“转换”。
有关如何在Cargo.toml中使用功能的信息，请参阅https://doc.rust-lang.net.cn/cargo/reference/manifest.html#the-features-section。
API端点文档
所有URI都是相对于https://dev-sg.portal.hocvienconggiao.com。
| 方法 | HTTP请求 | 描述 |
|---|---|---|
| activate_user | POST /mutation-api/identity-service/users/activation | 激活用户 |
| create-user | POST /mutation-api/identity-service/users | 创建用户 |
| deactivate_user | POST /mutation-api/identity-service/users/deactivation | 禁用用户 |
| password-update | PUT /mutation-api/identity-service/users/password-update | 密码更新 |
| update_user | PUT /mutation-api/identity-service/users/{id} | 更新现有用户 |
| query-user-by-id | GET /query-api/identity-service/users/{id} | 通过id获取用户信息 |
| query-users | GET /query-api/identity-service/users | 获取用户信息 |
| delete_user | DELETE /mutation-api/identity-service/users/{id} | 删除用户 |
模型文档
授权文档
user_auth
- 类型：Bearer令牌认证
示例
作者
依赖项
~12–24MB
~348K SLoC