README

LaPoste DataNOVA (开放数据API) 客户端和代理 Symfony 组件。

从LaPoste DataNOVA中检索和/或搜索数据集。

安装

步骤 1: 下载组件

打开命令行界面，进入项目目录，并执行以下命令以下载此组件的最新稳定版本

$ composer require florianajir/datanova-bundle

此命令需要您全局安装Composer，具体请参阅Composer文档的安装章节。

步骤 2: 启用组件

然后，将组件添加到项目src/config/bundles.php文件中注册的组件列表中，以启用组件

<?php
// src/config/bundles.php
return [
    // ...
    Fmaj\LaposteDatanovaBundle\FmajLaposteDatanovaBundle::class => ['all' => true],
    // ...
];

步骤 3: 使用API代理

要使用组件代理API，请将组件路由文件导入到项目的src/config/routing.yml文件中

data_nova:
    resource: "@FmajLaposteDatanovaBundle/Resources/config/routing.yml"
    prefix:   /datanova

步骤 4: 欣赏！

搜索记录

/records/search/{dataset}/{query}/{sort}/{rows}/{start}

示例：http://{localhost}/datanova/records/search/laposte_hexasmal/code_postal:34000/nom_de_la_commune

下载记录

/records/download/{dataset}.{_format}/{query}

示例：http://{localhost}/datanova/records/download/laposte_hexasmal.json

下载数据集（服务器缓存）

为了提高搜索性能，请使用data_nova:download:dataset命令来缓存数据集，以获得更好的网络搜索性能。更多详细信息请参阅数据集下载命令文档。

# /bin/bash
php bin/console datanova:download:dataset -h
Usage:
  datanova:download:dataset [options] [--] <dataset> [<format>] [<q>]

Arguments:
  dataset               Which dataset to download?
  format                Data file format : CSV (default), JSON [default: "CSV"]
  q                     query filter, by default all results will be download

Options:
  -f, --force-replace   If set, the command will replace local storage

示例：php bin/console datanova:download:dataset laposte_hexasmal json -f

florianajir / datanova-bundle

维护者

详细信息