3 个不稳定版本

0.1.2 2021年6月30日
0.1.1 2021年6月30日
0.0.1 2021年6月29日

#80 in #身份

无授权

105KB
2K SLoC

Rust 的 hvcg_identity_openapi_identity API

这是一个身份的 API。

概述

此客户端/服务器由 [openapi-generator] (https://openapi-generator.tech) 项目生成。通过使用来自远程服务器的 OpenAPI-Spec,您可以轻松生成服务器存根。

要了解如何将其变为自己的代码,请查看这里

README

  • API 版本:0.1.2
  • 构建日期:2021-06-30T04:56:43.924216055Z[Etc/UTC]

此自动生成项目定义了一个 API 包 hvcg_identity_openapi_identity,其中包含

  • 一个定义 Rust 中 API 的 Api 特质。
  • 表示底层数据模型的类型。
  • 一个实现 Api 并为每个操作发出 HTTP 请求的 Client 类型。
  • 一个接受 HTTP 请求并调用每个操作的适当 Api 方法的路由器。

它还包含一个示例服务器和客户端,它们使用了 hvcg_identity_openapi_identity

  • 示例服务器通过使用 hvcg_identity_openapi_identity 路由器启动一个 web 服务器,并提供了一个对每个操作都返回失败的简单 Api 实现。
  • 示例客户端提供了一个 CLI,允许您通过在命令行上传递适当的参数来调用 hvcg_identity_openapi_identity 客户端上的任何单个操作。

您可以将示例服务器和客户端作为您自己的代码的基础。有关实现服务器的更多详细信息,请参阅下面的 README

示例

使用以下命令运行示例

cargo run --example <example-name>

要将参数传递给示例,请在 -- 后放置它们,例如

cargo run --example client -- --help

运行示例服务器

要运行服务器,请按照以下简单步骤操作

cargo run --example server

运行示例客户端

要运行客户端,请按照以下简单步骤之一操作

cargo run --example client ActivateUser
cargo run --example client DeactivateUser
cargo run --example client QueryUserById
cargo run --example client QueryUsers

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均相对于http://dev-sg.portal.hocvienconggiao.com

方法 HTTP请求 描述
activate_user POST /mutation-api/users/activation 激活用户
deactivate_user POST /mutation-api/users/deactivation 禁用用户
update-password PUT /mutation-api/users/password 更新密码
query-user-by-id GET /query-api/users/{id} 通过ID获取用户信息
query-users GET /query-api/users 获取用户信息

模型文档

授权文档

user_auth

  • 类型:Bearer令牌认证

示例

作者

依赖项

~12–25MB
~351K SLoC