Rust API for hvcg_student_openapi_application

学生应用API

概览

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

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

README

• API版本：1.0.0
• 构建日期：2021-05-25T07:59:19.089121+07:00[亚洲/曼谷]

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

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

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

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

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

示例

使用以下命令运行示例

cargo run --example <example-name>

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

cargo run --example client -- --help

运行示例服务器

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

cargo run --example server

运行示例客户端

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

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 都相对于 http://petstore.swagger.io

模型文档

• ApiResponse
• Application
• ContactInfo
• Education
• Language
• LegalIdentification
• StudyProgram

授权文档

api_key

• 类型: API 密钥

示例

petstore_auth

• 类型: OAuth
• 流程: 隐式
• 授权 URL: http://petstore.swagger.io/api/oauth/dialog
• 作用域:
• write:pets: 修改您账户中的宠物
• read:pets: 读取您的宠物

示例

或通过 OAuth2 模块自动刷新令牌并执行用户身份验证。

作者