Lib.rs

Opendatasoft Explore API

opendatasoft-explore-api包是一个Opendatasoft Explore API v2客户端，旨在用于Rust项目中查询任何使用该软件的开放数据服务器，例如法国经济机构的开放数据门户。

由于API是稳定的，此工具可用于查询来自各种公司和公共行政机构的开放数据门户的元数据或记录。

它在Nasqueron的fantoir-datasource工具中使用，用于查询FANTOIR文件的附件信息，并确定是否有新文件可用。

如何使用它？

首先，将opendatasoft-explore-api添加到您的Cargo.toml依赖项中。您还需要一个异步实现。我们的代码与Tokio进行了测试。

然后，您可以创建ExploreApiEndPoint结构的实例。此时，它已准备好查询API

use opendatasoft_explore_api::requests::ExploreApiEndPoint;

static API_URL: &'static str = "https://data.economie.gouv.fr/api/v2";
static DATASET_ID: &'static str = "fichier-fantoir-des-voies-et-lieux-dits";

#[tokio::main]
async fn main() {
    let endpoint = ExploreApiEndPoint::new(API_URL);

    let dataset = endpoint.get_dataset_information(DATASET_ID).await;
    println!("{:?}", dataset);
}

文档可在https://docs.rs/opendatasoft-explore-api找到

实际使用示例也可在相同仓库的fantoir-datasource/src/commands/fetch文件夹中找到。

许可证

源代码根据BSD-2-Clause许可证发布。（c）2022-2023 Nasqueron项目，部分权利保留。

Nasqueron是一个自由文化和开源项目，与Opendatasoft公司无关。

注意：用于集成测试的tests/requests/中的文件描述了根据Licence Ouverte v2.0（Etalab）许可的数据集。它们不包括在编译的库中。

已知限制

目前，此实现不涵盖

• 身份验证，因为代码目前用于不需要身份验证的平台
• 可选参数，仅实现了强制参数

如果您有兴趣实现或需要这些参数之一，请与我们联系。这有助于我们确定优先级。

贡献

有用资源

• 问题与功能请求项目板
• 如何贡献代码

测试

请求的集成测试位于tests/文件夹中。

test/requests/中的文件是从针对data.economie.gouv.fr API门户的实际查询中缓存的： https://data.economie.gouv.fr/api/v2/console