Rust API for hvcg_governance_openapi_catholic-polity

这是一个天主教政治信息的服务器。

概览

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

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

README

• API 版本：0.11.0
• 构建日期：2021-11-08T08:22:53.842619534Z[Etc/UTC]

此自动生成的项目定义了一个 API 包 hvcg_governance_openapi_catholic-polity，它包含

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

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

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

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

示例

使用以下命令运行示例

cargo run --example <example-name>

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

cargo run --example client -- --help

运行示例服务器

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

cargo run --example server

运行示例客户端

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

cargo run --example client DeleteDeanery
cargo run --example client GetDeaneries
cargo run --example client GetDeaneryById
cargo run --example client DeleteDiocese
cargo run --example client GetDioceseById
cargo run --example client GetDioceses
cargo run --example client DeleteInstitute
cargo run --example client GetInstituteById
cargo run --example client GetInstitutes
cargo run --example client AddParish
cargo run --example client DeleteParish
cargo run --example client GetParishById
cargo run --example client GetParishes
cargo run --example client UpdateParish
cargo run --example client AddProvince
cargo run --example client DeleteProvince
cargo run --example client GetProvinceById
cargo run --example client GetProvinces
cargo run --example client UpdateProvince

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

模型文档说明

• 代码
• DeaneryCollection
• DeaneryMutation
• DeaneryView
• DioceseCollection
• DioceseMutation
• DioceseSortCriteria
• DioceseView
• InstituteCollection
• InstituteMutation
• InstituteSortCriteria
• InstituteView
• ParishCollection
• ParishMutation
• ParishView
• Polity
• ProvinceCollection
• 省变异
• 省视图

授权文档

polity_auth

• 类型：Bearer令牌身份验证

示例

作者