#协议 #google-api #google #web-api #api #web #firebaseremoteconfig

google-firebaseremoteconfig1

一个完整的库,用于与 Firebase Remote Config(协议 v1)进行交互

20 个稳定版本 (4 个主要版本)

5.0.5+20171129 2024年6月27日
5.0.4+20171129 2024年3月5日
5.0.3+20171129 2023年8月23日
5.0.2+20171129 2023年3月16日
1.0.6+20170912 2017年9月27日

#2635 in 网页编程


google-firebaseremoteconf… 中使用

MIT 许可证

120KB
1.5K SLoC

google-firebaseremoteconfig1 库允许访问 Google Firebase Remote Config(服务协议 v1)的所有功能。

本文档是根据 Firebase Remote Config crate 版本 5.0.5+20171129 生成的,其中 20171129 是由 mako 代码生成器 v5.0.5 构建的 firebaseremoteconfig:v1 架构的确切版本。

有关 Firebase Remote Config v1 API 的其他所有信息,请参阅 官方文档网站

功能

轻松从中央 枢纽 处处理以下 资源...

本库的结构

API 结构如下

  • 枢纽
  • 资源
    • 可以应用于 活动 的主要类型
    • 属性和 部分 的集合
    • 部分
      • 属性的集合
      • 永远不会在 活动中 直接使用
  • 活动
    • 应用于 资源 的操作

所有 结构 都用适用特性标记,以进一步分类它们并简化浏览。

一般来说,您可以像这样调用 活动

let r = hub.resource().activity(...).doit().await

或者具体地...

let r = hub.projects().get_remote_config(...).doit().await
let r = hub.projects().update_remote_config(...).doit().await

资源resource()和活动activity(...)调用创建构建器。第二个处理Activities,支持各种方法来配置即将进行的操作(此处未展示)。它的设计使得所有必需的参数都必须立即指定(即(...)),而所有可选的参数则可以按需构建doit()方法执行与服务器的实际通信,并返回相应的结果。

用法

设置你的项目

要使用此库,您需要将以下行放入您的Cargo.toml文件中

[dependencies]
google-firebaseremoteconfig1 = "*"
serde = "^1.0"
serde_json = "^1.0"

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_firebaseremoteconfig1 as firebaseremoteconfig1;
use firebaseremoteconfig1::api::RemoteConfig;
use firebaseremoteconfig1::{Result, Error};
use std::default::Default;
use firebaseremoteconfig1::{FirebaseRemoteConfig, oauth2, hyper, hyper_rustls, chrono, FieldMask};

// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: oauth2::ApplicationSecret = Default::default();
// Instantiate the authenticator. It will choose a suitable authentication flow for you, 
// unless you replace  `None` with the desired Flow.
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about 
// what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
// retrieve them from storage.
let auth = oauth2::InstalledFlowAuthenticator::builder(
        secret,
        oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    ).build().await.unwrap();
let mut hub = FirebaseRemoteConfig::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = RemoteConfig::default();

// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.projects().update_remote_config(req, "project")
             .validate_only(true)
             .doit().await;

match result {
    Err(e) => match e {
        // The Error enum provides details about what exactly happened.
        // You can also just use its `Debug`, `Display` or `Error` traits
         Error::HttpError(_)
        |Error::Io(_)
        |Error::MissingAPIKey
        |Error::MissingToken(_)
        |Error::Cancelled
        |Error::UploadSizeLimitExceeded(_, _)
        |Error::Failure(_)
        |Error::BadRequest(_)
        |Error::FieldClash(_)
        |Error::JsonDecodeError(_, _) => println!("{}", e),
    },
    Ok(res) => println!("Success: {:?}", res),
}

处理错误

系统产生的所有错误都作为Result枚举提供,作为doit()方法的返回值,或者作为可能的中继结果传递给Hub DelegateAuthenticator Delegate

当代理处理错误或中间值时,它们可能会有机会指示系统重试。这使得系统可能对所有类型的错误都具有弹性。

上传和下载

如果方法支持下载,响应体(作为Result的一部分)应由您读取以获取媒体。如果该方法还支持Response Result,则默认返回该结果。您可以将其视为实际媒体元数据。要触发媒体下载,您必须通过以下调用设置构建器:.param("alt", "media")

支持上传的方法可以使用最多两种不同的协议:简单可恢复。每种方法的特点由定制的doit(...)方法表示,分别命名为upload(...)upload_resumable(...)

自定义和回调

您可以通过在执行最终的doit()调用之前向Method Builder提供一个代理来修改doit()方法的方式。相应的方程序将被调用来提供进度信息,以及确定系统是否应在失败时重试。

代理特质默认实现,允许您以最小的努力进行自定义。

服务器请求中的可选部分

本库提供的所有结构都设计为可以通过json进行编码解码。使用可选类型来表示部分请求或响应是有效的。大多数可选类型都被视为部分,可以通过名称识别,这些部分将被发送到服务器以指示请求的设置部分或期望的响应部分。

构建器参数

通过使用方法构建器,您可以重复调用其方法来准备一个操作调用。这些方法始终接受单个参数,以下陈述对它适用。

  • PODs通过复制传递
  • 字符串作为&str传递
  • 请求值被移动

参数将始终被复制或克隆到构建器中,以确保它们与其原始生命周期独立。

Cargo功能

  • utoipa - 添加对utoipa的支持,并派生所有类型的utoipa::ToSchema。您需要在#[openapi(schemas(...))]中导入和注册所需的类型,否则生成的openapi规范将是无效的。

许可证

firebaseremoteconfig1库由Sebastian Thiel生成,并根据MIT许可证发布。您可以在存储库的许可证文件中阅读全文。

依赖关系

~12–22MB
~341K SLoC