16个版本 (6个破坏性)
| 0.7.4 | 2021年9月4日 |
|---|---|
| 0.6.1 | 2021年9月3日 |
| 0.4.0 | 2021年7月28日 |
#818 in HTTP服务器
每月44次下载
130KB
2.5K SLoC
Rust API for hvcg_biography_openapi_saint
这是一个示例服务器端Saint信息服务器。对于这个示例，您可以使用API密钥special-key来测试授权过滤器。
概述
此客户端/服务器由[openapi-generator] (https://openapi-generator.tech)项目生成。通过使用来自远程服务器的OpenAPI-Spec，您可以轻松生成服务器存根。
要了解如何将其作为自己的代码，请查看此处
- API版本：0.7.4
- 构建日期：2021-09-04T15:25:23.586182388Z[Etc/UTC]
此自动生成项目定义了一个名为hvcg_biography_openapi_saint的API crate，它包含
- 定义API的
Apitrait。 - 表示底层数据模型的数据类型。
- 实现
Api并针对每个操作发出HTTP请求的Client类型。 - 接受HTTP请求并调用每个操作的适当
Api方法的路由器。
它还包含一个示例服务器和客户端，它们使用hvcg_biography_openapi_saint。
- 示例服务器启动一个使用
hvcg_biography_openapi_saint路由器的Web服务器，并提供一个为每个操作返回失败的简单Api实现。 - 示例客户端提供了一个CLI，允许您通过在命令行中传递适当的参数来调用
hvcg_biography_openapi_saint客户端上的任何单个操作。
您可以使用示例服务器和客户端作为您自己的代码的基础。有关实现服务器的详细信息，请参阅下面的更多信息。
示例
使用以下命令运行示例
cargo run --example <example-name>
要向示例传递参数，请在--之后放置它们，例如
cargo run --example client -- --help
运行示例服务器
要运行服务器，请按照以下简单步骤操作
cargo run --example server
运行示例客户端
要运行客户端，请按照以下简单步骤之一进行操作
cargo run --example client DeleteSaint
cargo run --example client GetAllSaints
cargo run --example client GetSaintById
HTTPS
可以通过传递标志 --https 在 HTTPS 模式下运行示例，例如
cargo run --example server -- --https
这将使用示例目录中的密钥/证书。请注意，服务器链已由 CN=localhost 签名。
使用生成的库
生成的库具有一些可以通过 Cargo 激活的可选功能。
服务器- 默认启用，并基于 hyper 创建服务器实现的基本框架
- 要创建服务器堆栈，您需要提供一个 API 特性的实现以提供服务器功能。
客户端- 默认启用，并基于 hyper 创建客户端实现的基本框架
- 构建的客户端通过远程 API 调用来实现 API 特性。
转换- 默认禁用，并在模型上创建额外的 derives 以允许在结构上相似的类型之间进行“变形”。
有关如何在您的 Cargo.toml 中使用功能的说明，请参阅 https://doc.rust-lang.net.cn/cargo/reference/manifest.html#the-features-section。
API 端点文档
所有 URI 都相对于 https://dev-sg.portal.hocvienconggiao.com
| 方法 | HTTP 请求 | 描述 |
|---|---|---|
| addSaint | POST /mutation-api/saint-service/saints | 添加新的圣人 |
| delete_saint | DELETE /mutation-api/saint-service/saints/{id} | 删除一个圣人 |
| getAllSaints | GET /query-api/saint-service/saints | 获取所有圣人 |
| get_saint_by_id | GET /query-api/saint-service/saints/{id} | 通过 ID 查找圣人 |
| update_saint | PUT /mutation-api/saint-service/saints/{id} | 更新现有的圣人 |
模型文档
授权文档
saint_auth
- 类型: Bearer 令牌身份验证
示例
作者
依赖项
~12–24MB
~348K SLoC