1 个不稳定版本

使用旧的 Rust 2015

0.1.1	2019年10月7日

#156 在 #openapi

Unlicense

81KB
1.5K SLoC

Rust API for openapi_client

未提供描述（由 Openapi Generator 生成 https://github.com/openapitools/openapi-generator）

概述

此客户端/服务器由 [openapi-generator]（https://openapi-generator.tech）项目生成。通过使用远程服务器的 OpenAPI-Spec，您可以轻松生成服务器占位符。

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

README

API 版本：0.1.1
构建日期：2019-10-07T07:41:44.464Z[GMT]

此自动生成项目定义了一个名为 openapi_client 的 API 包，它包含

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

它还包含一个示例服务器和客户端，它们使用了 openapi_client。

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

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

示例

使用以下命令运行示例

cargo run --example <example-name>

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

cargo run --example client -- --help

运行示例服务器

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

cargo run --example server

运行示例客户端

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

cargo run --example client DataSourcesDataSourceIdEntitiesEntityIdChangesPost
cargo run --example client DataSourcesDataSourceIdSynchronizationStateGet
cargo run --example client DataSourcesGet
cargo run --example client DataSourcesPost

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://127.0.0.1

方法	HTTP请求	描述
****	POST /data-sources/{dataSourceId}/entities/{entityId}/changes	同步数据源更改
****	GET /data-sources/{dataSourceId}/synchronization-state	列出数据源同步状态
****	GET /data-sources	列出已注册的数据源
****	POST /data-sources	注册数据源

openapi_client